API-Reference.ja.md in ruby-dnn-0.6.6 vs API-Reference.ja.md in ruby-dnn-0.6.7
- old
+ new
@@ -1,10 +1,10 @@
# APIリファレンス
ruby-dnnのAPIリファレンスです。このリファレンスでは、APIを利用するうえで必要となるクラスとメソッドしか記載していません。
そのため、プログラムの詳細が必要な場合は、ソースコードを参照してください。
-最終更新バージョン:0.6.4
+最終更新バージョン:0.6.7
# module DNN
ruby-dnnの名前空間をなすモジュールです。
## 【Constants】
@@ -21,12 +21,10 @@
モデルに追加されたレイヤーの配列を取得します。
## attr_accessor :trainable
falseを設定すると、パラメータの学習を禁止します。
-## attr_reader :optimize
-モデルのオプティマイザーを取得します。
## 【Singleton methods】
## def self.load(file_name)
marshalファイルを読み込み、モデルを作成します。
@@ -83,18 +81,27 @@
### return
String
学習パラメータを変換して生成したjson文字列。
## def <<(layer)
-モデルにレイヤーを追加します。
+モデルにレイヤーまたはモデルを追加します。
### arguments
-* Layer layer
-追加するレイヤー。
+* Layer | Model layer
+追加するレイヤーまたはモデル。
### return
Model
自身のモデルのインスタンス。
+## def optimizer
+モデルのオプティマイザーを取得します。
+モデルにオプティマイザーが存在しない場合は、上位のモデルのオプティマイザーを取得します。
+### arguments
+なし。
+### return
+Optimizer
+モデルのオプティマイザー。
+
## def compile(optimizer)
モデルをコンパイルします。
### arguments
* Optimizer optimizer
モデルが学習に使用するオプティマイザー。
@@ -114,11 +121,11 @@
### arguments
* Numo::SFloat x
トレーニング用入力データ。
* Numo::SFloat y
トレーニング用出力データ。
-* epochs
+* Integer epochs
学習回数。
* Integer batch_size: 1
学習に使用するミニバッチの数。
* Array test: nil
[テスト用入力データ, テスト用出力データ]の形式で設定すると、1エポックごとにテストを行います。
@@ -231,11 +238,11 @@
### return
Array
レイヤーの形状。Layerクラスのshapeメソッドでは、前レイヤーの形状を返却します。
## abstruct def to_hash
-レイヤーをハッシュに変換します。このメソッドは、モデルをjsonに変換するために使用されます。このメソッドが返すハッシュの要素には、{name: self.class.name}が含まれていなければなりません。
+レイヤーをハッシュに変換します。このメソッドは、モデルをjsonに変換するために使用されます。このメソッドが返すハッシュの要素には、{name: `self.class.name`}が含まれていなければなりません。
### arguments
なし。
### return
Hash
レイヤーを変換したハッシュ。
@@ -246,9 +253,10 @@
## 【Instance methods】
## private abstruct def init_params
更新可能なパラメータを初期化します。HasParamLayerクラスを継承するクラスは、このメソッドを実装する必要があります。
+このメソッドは、レイヤーが初回ビルドされたときのみ実行されます。
### arguments
なし。
### return
なし。