ruby-dnn 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8156ccf7edaf425d09a1463bb1c9280a1eeddaa67448323a19d301d451a78a0f
-  data.tar.gz: 851e5aa8c87fd60ee9d5296f995c9b884a1bcaed823ab9e5d034f0b7b52d740b
+  metadata.gz: 6c69ef32fd33f04c1452e3b16a6de42d69274fa717726b0306b30a530935d059
+  data.tar.gz: 3ef80bd96e8328c0bc06762de1440f05eab109fecd3519ff0460abdcbfc2194d
 SHA512:
-  metadata.gz: 520b9dc2ff534d36d86af82750b12a1772d29b487cfc18e02425f14c006e9fc1a15c525a0f1cfbe1ce541d2c7cac0cc7649a0542f3b9448634daf9869471f5d3
-  data.tar.gz: 2ffe038bc5e5b69c61f32f99e9b21df8b2321b32148c6226d85e9aa82cedd8bade8bcbdab66c983a827a923ab3d3e449bb03cedb4c52f9b34fcbd1a732220e43
+  metadata.gz: dc501da4b2681cc1a3c65c8af2234685618872c466ca720e38692a7c2610d9b4520709babac1c20f91b675cfb74a4e317a71831aba04a71337148d1f4c8effda
+  data.tar.gz: 01cc6815889a578da2601c205b86277ad674531c4020ff624a2f15ea17ea4fe070a4b69228d6f53585f235d96d28d8d44132035d7adb2d963de94c9a3a785fbf

data/API-Reference.ja.md

@@ -2,7 +2,7 @@
 ruby-dnnのAPIリファレンスです。このリファレンスでは、APIを利用するうえで必要となるクラスとメソッドしか記載していません。
 そのため、プログラムの詳細が必要な場合は、ソースコードを参照してください。
 
-最終更新バージョン:0.4.0
+最終更新バージョン:0.4.2
 
 # module DNN
 ruby-dnnの名前空間をなすモジュールです。
@@ -471,6 +471,11 @@ tanh関数のレイヤーです。
 # class LeakyReLU < Layer
 LeakyReLU関数のレイヤーです。
 
+## 【Properties】
+## attr_reader :alpha
+Float alpha  
+出力値が負のときの傾き。
+
 ## 【Instance methods】
 
 ## def initialize(alpha)

data/lib/dnn/core/activations.rb

@@ -5,11 +5,11 @@ module DNN
 
     class Sigmoid < Layer
       def forward(x)
-        @out = 1.0 / (1 + NMath.exp(-x))
+        @out = 1 / (1 + NMath.exp(-x))
       end
     
       def backward(dout)
-        dout * (1.0 - @out) * @out
+        dout * (1 - @out) * @out
       end
     end
 
@@ -46,6 +46,8 @@ module DNN
     class LeakyReLU < Layer
       include Xumo
 
+      attr_reader :alpha
+
       def initialize(alpha = 0.3)
         @alpha = alpha
       end

data/lib/dnn/core/initializers.rb

@@ -6,8 +6,8 @@ module DNN
         layer.params[param_key] = param
       end
 
-      def to_hash
-        {name: self.class.name}
+      def to_hash(hash)
+        {name: self.class.name}.merge(hash)
       end
     end
 
@@ -37,7 +37,7 @@ module DNN
       end
 
       def to_hash
-        {name: self.class.name, mean: @mean, std: @std}
+        super({mean: @mean, std: @std})
       end
     end
     

data/lib/dnn/core/layers.rb

@@ -1,7 +1,7 @@
 module DNN
   module Layers
 
-    #Super class of all optimizer classes.
+    # Super class of all optimizer classes.
     class Layer
       include Xumo
 
@@ -9,43 +9,44 @@ module DNN
         @built = false
       end
 
-      #Build the layer.
+      # Build the layer.
       def build(model)
         @built = true
         @model = model
       end
       
-      #Does the layer have already been built?
+      # Does the layer have already been built?
       def built?
         @built
       end
 
-      #Forward propagation.
+      # Forward propagation.
       def forward() end
 
-      #Backward propagation.
+      # Backward propagation.
       def backward() end
     
-      #Get the shape of the layer.
+      # Get the shape of the layer.
       def shape
         prev_layer.shape
       end
 
-      #Layer to a hash.
-      def to_hash
-        {name: self.class.name}
+      # Layer to a hash.
+      def to_hash(hash)
+        {name: self.class.name}.merge(hash)
       end
     
-      #Get the previous layer.
+      # Get the previous layer.
       def prev_layer
         @model.layers[@model.layers.index(self) - 1]
       end
     end
     
     
+    # This class is a superclass of all classes with learning parameters.
     class HasParamLayer < Layer
-      attr_reader :params #The parameters of the layer.
-      attr_reader :grads  #Differential value of parameter of layer.
+      attr_reader :params # The parameters of the layer.
+      attr_reader :grads  # Differential value of parameter of layer.
     
       def initialize
         super
@@ -58,14 +59,14 @@ module DNN
         init_params
       end
     
-      #Update the parameters.
+      # Update the parameters.
       def update
         @model.optimizer.update(self)
       end
     
       private
       
-      #Initialize of the parameters.
+      # Initialize of the parameters.
       def init_params() end
     end
     
@@ -91,7 +92,7 @@ module DNN
       end
 
       def to_hash
-        {name: self.class.name, shape: @shape}
+        super({shape: @shape})
       end
     end
     
@@ -140,13 +141,10 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          num_nodes: @num_nodes,
-          weight_initializer: @weight_initializer.to_hash,
-          bias_initializer: @bias_initializer.to_hash,
-          weight_decay: @weight_decay,
-        }
+        super({num_nodes: @num_nodes,
+               weight_initializer: @weight_initializer.to_hash,
+               bias_initializer: @bias_initializer.to_hash,
+               weight_decay: @weight_decay})
       end
     
       private
@@ -292,16 +290,13 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          num_filters: @num_filters,
-          filter_size: @filter_size,
-          weight_initializer: @weight_initializer.to_hash,
-          bias_initializer: @bias_initializer.to_hash,
-          strides: @strides,
-          padding: @padding,
-          weight_decay: @weight_decay,
-        }
+        super({num_filters: @num_filters,
+               filter_size: @filter_size,
+               weight_initializer: @weight_initializer.to_hash,
+               bias_initializer: @bias_initializer.to_hash,
+               strides: @strides,
+               padding: @padding,
+               weight_decay: @weight_decay})
       end
     
       private
@@ -371,13 +366,10 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          pool_width: @pool_width,
-          pool_height: @pool_height,
-          strides: @strides,
-          padding: @padding,
-        }
+        super({pool_width: @pool_width,
+               pool_height: @pool_height,
+               strides: @strides,
+               padding: @padding})
       end
     end
 
@@ -423,10 +415,7 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          unpool_size: @unpool_size,
-        }
+        super({unpool_size: @unpool_size})
       end
     end
     
@@ -470,7 +459,7 @@ module DNN
       end
 
       def to_hash
-        {name: self.class.name, shape: @shape}
+        super({shape: @shape})
       end
     end
 
@@ -518,7 +507,7 @@ module DNN
       end
 
       def to_hash
-        {name: self.class.name, dropout_ratio: @dropout_ratio}
+        super({dropout_ratio: @dropout_ratio})
       end
     end
     
@@ -576,12 +565,9 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          momentum: @momentum,
-          running_mean: @running_mean.to_a,
-          running_var: @running_var.to_a,
-        }
+        super({momentum: @momentum,
+               running_mean: @running_mean.to_a,
+               running_var: @running_var.to_a})
       end
     
       private

data/lib/dnn/core/model.rb

@@ -1,6 +1,7 @@
 require "json"
 
 module DNN
+  # This class deals with the model of the network.
   class Model
     include Xumo
     

data/lib/dnn/core/optimizers.rb

@@ -1,7 +1,7 @@
 module DNN
   module Optimizers
 
-    #Super class of all optimizer classes.
+    # Super class of all optimizer classes.
     class Optimizer
       attr_accessor :learning_rate
 
@@ -9,11 +9,11 @@ module DNN
         @learning_rate = learning_rate
       end
 
-      #Update layer has params.
+      # Update layer has params.
       def update(layer) end
 
-      def to_hash
-        {name: self.class.name, learning_rate: @learning_rate}
+      def to_hash(hash)
+        {name: self.class.name, learning_rate: @learning_rate}.merge(hash)
       end
     end
 
@@ -21,39 +21,31 @@ module DNN
     class SGD < Optimizer
       attr_accessor :momentum
 
+      def self.load_hash(hash)
+        self.new(hash[:learning_rate], momentum: hash[:momentum])
+      end
+
       def initialize(learning_rate = 0.01, momentum: 0)
         super(learning_rate)
         @momentum = momentum
-        @amounts = {}
-      end
-
-      def self.load_hash(hash)
-        self.new(hash[:learning_rate], hash[:momentum])
+        @v = {}
       end
     
       def update(layer)
-        amount = if @amounts[layer]
-          @amounts[layer]
-        else
-          @amounts[layer] = {}
-        end
+        @v[layer] ||= {}
         layer.params.each_key do |key|
-          amount[key] = layer.grads[key] * @learning_rate
+          amount = layer.grads[key] * @learning_rate
           if @momentum > 0
-            @amounts[layer][key] ||= 0
-            amount[key] += @momentum * @amounts[layer][key]
-            @amounts[layer] = amount
+            @v[layer][key] ||= 0
+            amount += @momentum * @v[layer][key]
+            @v[layer][key] = amount
           end
-          layer.params[key] -= amount[key]
+          layer.params[key] -= amount
         end
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          learning_rate: @learning_rate,
-          momentum: @momentum,
-        }
+        super({momentum: @momentum})
       end
     end
     
@@ -102,11 +94,7 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          learning_rate: @learning_rate,
-          muse: @muse,
-        }
+        super({muse: @muse})
       end
     end
 
@@ -145,12 +133,7 @@ module DNN
       end
 
       def to_hash
-        {
-          name: self.class.name,
-          learning_rate: @learning_rate,
-          beta1: @beta1,
-          beta2: @beta2,
-        }
+        super({beta1: @beta1, beta2: @beta2})
       end
     end
 

data/lib/dnn/core/util.rb

@@ -1,12 +1,13 @@
 module DNN
+  # This module provides utility functions.
   module Util
-    #Create a mini batch for batch size.
+    # Create a mini batch for "batch_size".
     def self.get_minibatch(x, y, batch_size)
       indexes = (0...x.shape[0]).to_a.sample(batch_size)
       [x[indexes, false], y[indexes, false]]
     end
 
-    #Categorize labels into "num_classes" classes.
+    # Categorize labels into "num_classes" classes.
     def self.to_categorical(y, num_classes, narray_type = nil)
       narray_type ||= y.class
       y2 = narray_type.zeros(y.shape[0], num_classes)
@@ -16,12 +17,12 @@ module DNN
       y2
     end
   
-    #Perform numerical differentiation on "forward" of "layer".
+    # Perform numerical differentiation.
     def self.numerical_grad(x, func)
       (func.(x + 1e-7) - func.(x)) / 1e-7
     end
 
-    #Convert hash to an object.
+    # Convert hash to an object.
     def self.load_hash(hash)
       dnn_class = DNN.const_get(hash[:name])
       if dnn_class.respond_to?(:load_hash)

data/lib/dnn/version.rb

@@ -1,3 +1,3 @@
 module DNN
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dnn
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - unagiootoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray