API-Reference.ja.md in ruby-dnn-0.3.0 vs API-Reference.ja.md in ruby-dnn-0.3.1
- old
+ new
@@ -1,10 +1,10 @@
# APIリファレンス
ruby-dnnのAPIリファレンスです。このリファレンスでは、APIを利用するうえで必要となるクラスとメソッドしか記載していません。
そのため、プログラムの詳細が必要な場合は、ソースコードを参照してください。
-最終更新バージョン:0.3.0
+最終更新バージョン:0.3.1
# module DNN
ruby-dnnの名前空間をなすモジュールです。
## 【Constants】
@@ -247,11 +247,12 @@
# class Dense
全結合レイヤーを扱うクラスです。
-## 【propaty】
+## 【Properties】
+
## attr_reader :num_nodes
Integer
レイヤーのノード数を取得します。
## attr_reader :weight_decay
@@ -276,10 +277,30 @@
# class Conv2D < HasParamLayer
畳み込みレイヤーを扱うクラスです。
+## 【Properties】
+
+## attr_reader :num_filters
+Integer
+出力するフィルターの枚数。
+
+## attr_reader :filter_size
+Array
+フィルターの横と縦の長さ。
+[Integer width, Integer height]の形式で取得します。
+
+## attr_reader :strides
+Array
+畳み込みを行う際のストライドの単位。
+[Integer width, Integer height]の形式で取得します。
+
+## attr_reader :weight_decay
+Float
+重み減衰を行うL2正則化項の強さを取得します。
+
## 【Instance methods】
## def initialize(num_filters, filter_size, weight_initializer: nil, bias_initializer: nil, strides: 1, padding false, weight_decay: 0)
コンストラクタ。
### arguments
@@ -304,10 +325,22 @@
# class MaxPool2D < Layer
maxプーリングを行うレイヤーです。
+## 【Properties】
+
+## attr_reader :pool_size
+Array
+プーリングを行う横と縦の長さ。
+[Integer width, Integer height]の形式で取得します。
+
+## attr_reader :strides
+Array
+畳み込みを行う際のストライドの単位。
+[Integer width, Integer height]の形式で取得します。
+
## 【Instance methods】
## def initialize(pool_size, strides: nil, padding: false)
コンストラクタ。
### arguments
@@ -324,10 +357,17 @@
# class UnPool2D < Layer
逆プーリングを行うレイヤーです。
+## 【Properties】
+
+## attr_reader :unpool_size
+Array
+逆プーリングを行う横と縦の長さ。
+[Integer width, Integer height]の形式で取得します。
+
## 【Instance methods】
## def initialize(unpool_size)
コンストラクタ。
### arguments
@@ -375,19 +415,42 @@
# class Dropout
学習の際に、一部のノードを非活性化させるクラスです。
+## 【Properties】
+
+## attr_reader :dropout_ratio
+ノードを非活性にする割合を取得します。
+
## 【Instance methods】
+
## def initialize(dropout_ratio)
コンストラクタ。
### arguments
* Float dropout_ration
ノードを非活性にする割合。
# class BatchNormalization < HasParamLayer
ミニバッチ単位でのデータの正規化を行います。
+
+## 【Properties】
+
+## attr_reader :momentum
+推論時に使用する平均と分散を求めるための指数平均移動の係数。
+
+## 【Instance methods】
+
+## def initialize(momentum: 0.9, running_mean: nil, running_var: nil)
+コンストラクタ。
+### arguments
+* Float momenum: 0.9
+推論時に使用する平均と分散を求めるための指数平均移動の係数。
+* Float running_mean: nil
+推論時に使用する平均。
+* Float running_var: nil
+推論時に使用する分散。
# module Activations
活性化関数のレイヤーの名前空間をなすモジュールです。