API-Reference.ja.md in ruby-dnn-0.8.1 vs API-Reference.ja.md in ruby-dnn-0.8.2

@@ -1,10 +1,10 @@
 # APIリファレンス
 ruby-dnnのAPIリファレンスです。このリファレンスでは、APIを利用するうえで必要となるクラスとメソッドしか記載していません。
 そのため、プログラムの詳細が必要な場合は、ソースコードを参照してください。
 
-最終更新バージョン:0.8.0
+最終更新バージョン:0.8.2
 
 # module DNN
 ruby-dnnの名前空間をなすモジュールです。
 
 ## 【Constants】
@@ -334,21 +334,19 @@
 Integer  
 レイヤーのノード数を取得します。
 
 ## 【Instance methods】
 
-## def initialize(num_nodes, weight_initializer: nil, bias_initializer: nil, l1_lambda: 0, l2_lambda: 0)
+## def initialize(num_nodes, weight_initializer: Initializers::RandomNormal.new, bias_initializer: Initializers::Zeros.new, l1_lambda: 0, l2_lambda: 0)
 コンストラクタ。
 ### arguments
 * Integer num_nodes  
 レイヤーのノード数を設定します。
-* Initializer weight_initializer: nil  
+* Initializer weight_initializer: Initializers::RandomNormal.new  
 重みの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、RandomNormalイニシャライザーが使用されます。  
-* Initializer bias_initializer: nil  
+* Initializer bias_initializer: Initializers::Zeros.new  
 バイアスの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、Zerosイニシャライザーが使用されます。
 * Float l1_lambda: 0  
 重みのL1正則化の係数を設定します。
 * Float l2_lambda: 0  
 重みのL2正則化の係数を設定します。
 
@@ -372,22 +370,21 @@
 畳み込みを行う際のストライドの単位。  
 [Integer height, Integer width]の形式で取得します。
 
 ## 【Instance methods】
 
-## def initialize(num_filters, filter_size, weight_initializer: nil, bias_initializer: nil, strides: 1, padding false, l1_lambda: 0, l2_lambda: 0)
+## def initialize(num_filters, filter_size, weight_initializer: Initializers::RandomNormal.new, bias_initializer: Initializers::Zeros.new, strides: 1, padding false, l1_lambda: 0, l2_lambda: 0)
 コンストラクタ。
 ### arguments
 * Integer num_filters  
 出力するフィルターの枚数。
 * Integer | Array filter_size  
 フィルターの縦と横の長さ。
 Arrayで指定する場合、[Integer height, Integer width]の形式で指定します。
-* Initializer weight_initializer: nil  
-重みの初期化に使用するイニシャライザーを設定します
-nilを指定すると、RandomNormalイニシャライザーが使用されます。  
-* Initializer bias_initializer: nil  
+* Initializer weight_initializer: Initializers::RandomNormal.new  
+重みの初期化に使用するイニシャライザーを設定します。
+* Initializer bias_initializer: Initializers::Zeros.new  
 バイアスの初期化に使用するイニシャライザーを設定します。
 * Array<Integer> strides: 1  
 畳み込みを行う際のストライドの単位を指定します。
 Arrayで指定する場合、[Integer height, Integer width]の形式で指定します。
 * bool padding: true  
@@ -470,26 +467,24 @@
 bool  
 レイヤーがステートフルであるか否かを返します。
 
 ## 【Instance methods】
 
-## def initialize(num_nodes, stateful: false, return_sequences: true, weight_initializer: nil, bias_initializer: nil, l1_lamda: 0, l2_lambda: 0)
+## def initialize(num_nodes, stateful: false, return_sequences: true, weight_initializer: Initializers::RandomNormal.new, bias_initializer: Initializers::Zeros.new, l1_lamda: 0, l2_lambda: 0)
 コンストラクタ。
 ### arguments
 * Integer num_nodes  
 レイヤーのノード数を設定します。
 * bool stateful  
 trueを設定すると、一つ前に計算した中間層の値を使用して学習を行うことができます。
 * bool return_sequences
 trueを設定すると、時系列ネットワークの中間層全てを出力します。  
 falseを設定すると、時系列ネットワークの中間層の最後のみを出力します。
-* Initializer weight_initializer: nil  
+* Initializer weight_initializer: Initializers::RandomNormal.new  
 重みの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、RandomNormalイニシャライザーが使用されます。  
-* Initializer bias_initializer: nil  
+* Initializer bias_initializer: Initializers::Zeros.new  
 バイアスの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、Zerosイニシャライザーが使用されます。
 * Float l1_lambda: 0  
 重みのL1正則化の係数を設定します。
 * Float l2_lambda: 0  
 重みのL2正則化の係数を設定します。
 
@@ -500,11 +495,11 @@
 # class SimpleRNN < RNN
 シンプルなRNNレイヤーを扱うクラスです。
 
 ## 【Instance methods】
 
-## def initialize(num_nodes, stateful: false, return_sequences: true,  activation: nil, weight_initializer: nil, bias_initializer: nil, l1_lamda: 0, l2_lambda: 0)
+## def initialize(num_nodes, stateful: false, return_sequences: true,  activation: Tanh.new, weight_initializer: Initializers::RandomNormal.new, bias_initializer: Initializers::Zeros.new, l1_lamda: 0, l2_lambda: 0)
 コンストラクタ。
 ### arguments
 * Integer num_nodes  
 レイヤーのノード数を設定します。
 * bool stateful
@@ -512,17 +507,14 @@
 * bool return_sequences
 trueを設定すると、時系列ネットワークの中間層全てを出力します。  
 falseを設定すると、時系列ネットワークの中間層の最後のみを出力します。
 * Layer activation
 リカレントニューラルネットワークにおいて、使用する活性化関数を設定します。
-nilを指定すると、Tanhが使用されます。
 * Initializer weight_initializer: nil  
 重みの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、RandomNormalイニシャライザーが使用されます。  
 * Initializer bias_initializer: nil  
 バイアスの初期化に使用するイニシャライザーを設定します。
-nilを指定すると、Zerosイニシャライザーが使用されます。
 * Float l1_lambda: 0  
 重みのL1正則化の係数を設定します。
 * Float l2_lambda: 0  
 重みのL2正則化の係数を設定します。
 
@@ -692,17 +684,15 @@
 # class Initializer
 全てのInitializeクラスのスーパークラスです。
 
 ## 【Instance methods】
 
-## def init_param(layer, param_key, param)
+## def init_param(layer, param)
 レイヤーの持つパラメータを更新します。
 ### arguments
 * HasParamLayer layer  
 更新対象のパラメータを持つレイヤーを指定します。
-* Symbol param_key  
-更新す対象のパラメータの名前を指定します。
-* Numo::SFloat param  
+* LearningParam param  
 更新するパラメータです。
 
 
 # class Zeros < Initializer
 パラメータを0で初期化します。