Class: DNN::Layers::RNN

Inherits:
Connection show all
Defined in:
lib/dnn/core/rnn_layers.rb

Overview

Super class of all RNN classes.

Direct Known Subclasses

GRU, LSTM, SimpleRNN

Instance Attribute Summary collapse

Attributes inherited from Connection

#bias, #bias_initializer, #bias_regularizer, #weight, #weight_initializer, #weight_regularizer

Attributes inherited from HasParamLayer

#trainable

Attributes inherited from Layer

#input_shape, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

#use_bias

Methods inherited from Layer

#built?, #call, call

Constructor Details

#initialize(num_nodes, stateful: false, return_sequences: true, weight_initializer: Initializers::RandomNormal.new, recurrent_weight_initializer: Initializers::RandomNormal.new, bias_initializer: Initializers::Zeros.new, weight_regularizer: nil, recurrent_weight_regularizer: nil, bias_regularizer: nil, use_bias: true) ⇒ RNN

Returns a new instance of RNN.

Parameters:

  • num_nodes (Integer) —

    Number of nodes.

  • stateful (Boolean) (defaults to: false) —

    Maintain state between batches.

  • return_sequences (Boolean) (defaults to: true) —

    Set the false, only the last of each cell of RNN is left.

  • recurrent_weight_initializer (DNN::Initializers::Initializer) (defaults to: Initializers::RandomNormal.new) —

    Recurrent weight initializer.

  • recurrent_weight_regularizer (DNN::Regularizers::Regularizer | NilClass) (defaults to: nil) —

    Recurrent weight regularizer.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/dnn/core/rnn_layers.rb', line 32

def initialize(num_nodes,
               stateful: false,
               return_sequences: true,
               weight_initializer: Initializers::RandomNormal.new,
               recurrent_weight_initializer: Initializers::RandomNormal.new,
               bias_initializer: Initializers::Zeros.new,
               weight_regularizer: nil,
               recurrent_weight_regularizer: nil,
               bias_regularizer: nil,
               use_bias: true)
  super(weight_initializer: weight_initializer, bias_initializer: bias_initializer,
        weight_regularizer: weight_regularizer, bias_regularizer: bias_regularizer, use_bias: use_bias)
  @num_nodes = num_nodes
  @stateful = stateful
  @return_sequences = return_sequences
  @layers = []
  @hidden = Param.new
  @recurrent_weight = Param.new(nil, 0)
  @recurrent_weight_initializer = recurrent_weight_initializer
  @recurrent_weight_regularizer = recurrent_weight_regularizer
end

Instance Attribute Details

#hidden ⇒ Object (readonly)

Returns the value of attribute hidden.



8
9
10
 
# File 'lib/dnn/core/rnn_layers.rb', line 8

def hidden
  @hidden
end

#num_nodes ⇒ Object (readonly)

Returns the value of attribute num_nodes.



6
7
8
 
# File 'lib/dnn/core/rnn_layers.rb', line 6

def num_nodes
  @num_nodes
end

#recurrent_weight ⇒ Object (readonly)

Returns the value of attribute recurrent_weight.



7
8
9
 
# File 'lib/dnn/core/rnn_layers.rb', line 7

def recurrent_weight
  @recurrent_weight
end

#recurrent_weight_initializer ⇒ Object (readonly)

Returns the value of attribute recurrent_weight_initializer.



11
12
13
 
# File 'lib/dnn/core/rnn_layers.rb', line 11

def recurrent_weight_initializer
  @recurrent_weight_initializer
end

#recurrent_weight_regularizer ⇒ Object (readonly)

Returns the value of attribute recurrent_weight_regularizer.



12
13
14
 
# File 'lib/dnn/core/rnn_layers.rb', line 12

def recurrent_weight_regularizer
  @recurrent_weight_regularizer
end

#return_sequences ⇒ Object (readonly)

Returns the value of attribute return_sequences.



10
11
12
 
# File 'lib/dnn/core/rnn_layers.rb', line 10

def return_sequences
  @return_sequences
end

#stateful ⇒ Object (readonly)

Returns the value of attribute stateful.



9
10
11
 
# File 'lib/dnn/core/rnn_layers.rb', line 9

def stateful
  @stateful
end

Class Method Details

.from_hash(hash) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/dnn/core/rnn_layers.rb', line 14

def self.from_hash(hash)
  self.new(hash[:num_nodes],
           stateful: hash[:stateful],
           return_sequences: hash[:return_sequences],
           weight_initializer: Utils.hash_to_obj(hash[:weight_initializer]),
           recurrent_weight_initializer: Utils.hash_to_obj(hash[:recurrent_weight_initializer]),
           bias_initializer: Utils.hash_to_obj(hash[:bias_initializer]),
           weight_regularizer: Utils.hash_to_obj(hash[:weight_regularizer]),
           recurrent_weight_regularizer: Utils.hash_to_obj(hash[:recurrent_weight_regularizer]),
           bias_regularizer: Utils.hash_to_obj(hash[:bias_regularizer]),
           use_bias: hash[:use_bias])
end

Instance Method Details

#backward(dh2s) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/dnn/core/rnn_layers.rb', line 76

def backward(dh2s)
  unless @return_sequences
    dh = dh2s
    dh2s = Xumo::SFloat.zeros(dh.shape[0], @time_length, dh.shape[1])
    dh2s[true, -1, false] = dh
  end
  dxs = Xumo::SFloat.zeros(@xs_shape)
  dh = 0
  (0...dh2s.shape[1]).to_a.reverse.each do |t|
    dh2 = dh2s[true, t, false]
    dx, dh = @layers[t].backward(dh2 + dh)
    dxs[true, t, false] = dx
  end
  dxs
end

#build(input_shape) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/dnn/core/rnn_layers.rb', line 54

def build(input_shape)
  unless input_shape.length == 2
    raise DNN_ShapeError.new("Input shape is #{input_shape}. But input shape must be 2 dimensional.")
  end
  super
  @time_length = @input_shape[0]
end

#forward(xs) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/dnn/core/rnn_layers.rb', line 62

def forward(xs)
  @xs_shape = xs.shape
  hs = Xumo::SFloat.zeros(xs.shape[0], @time_length, @num_nodes)
  h = @stateful && @hidden.data ? @hidden.data : Xumo::SFloat.zeros(xs.shape[0], @num_nodes)
  xs.shape[1].times do |t|
    x = xs[true, t, false]
    @layers[t].trainable = @trainable
    h = @layers[t].forward(x, h)
    hs[true, t, false] = h
  end
  @hidden.data = h
  @return_sequences ? hs : h
end

#get_params ⇒ Object 



108
109
110
 
# File 'lib/dnn/core/rnn_layers.rb', line 108

def get_params
  { weight: @weight, recurrent_weight: @recurrent_weight, bias: @bias, hidden: @hidden }
end

#output_shape ⇒ Object 



92
93
94
 
# File 'lib/dnn/core/rnn_layers.rb', line 92

def output_shape
  @return_sequences ? [@time_length, @num_nodes] : [@num_nodes]
end

#regularizers ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/dnn/core/rnn_layers.rb', line 117

def regularizers
  regularizers = []
  regularizers << @weight_regularizer if @weight_regularizer
  regularizers << @recurrent_weight_regularizer if @recurrent_weight_regularizer
  regularizers << @bias_regularizer if @bias_regularizer
  regularizers
end

#reset_state ⇒ Object

Reset the state of RNN.



113
114
115
 
# File 'lib/dnn/core/rnn_layers.rb', line 113

def reset_state
  @hidden.data = @hidden.data.fill(0) if @hidden.data
end

#to_hash(merge_hash = nil) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/dnn/core/rnn_layers.rb', line 96

def to_hash(merge_hash = nil)
  hash = {
    num_nodes: @num_nodes,
    stateful: @stateful,
    return_sequences: @return_sequences,
    recurrent_weight_initializer: @recurrent_weight_initializer.to_hash,
    recurrent_weight_regularizer: @recurrent_weight_regularizer&.to_hash,
  }
  hash.merge!(merge_hash) if merge_hash
  super(hash)
end