ruby-dnn 0.13.4 → 0.14.0

data/lib/dnn/core/utils.rb

@@ -23,7 +23,7 @@ module DNN
 
     # Return the result of the sigmoid function.
     def self.sigmoid(x)
-      Activations::Sigmoid.new.forward(x)
+      Layers::Sigmoid.new.forward(x)
     end
 
     # Return the result of the softmax function.

data/lib/dnn/image.rb

@@ -14,6 +14,9 @@ module DNN
     RGB = 3
     RGBA = 4
 
+    # Read image from file.
+    # @param [String] file_name File name to read.
+    # @param [Integer] channel_type Specify channel type of image.
     def self.read(file_name, channel_type = RGB)
       raise ImageReadError.new("#{file_name} is not found.") unless File.exist?(file_name)
       bin, w, h, n = Stb.stbi_load(file_name, channel_type)
@@ -22,6 +25,10 @@ module DNN
       img.reshape(h, w, channel_type)
     end
 
+    # Write image to file.
+    # @param [String] file_name File name to write.
+    # @param [Numo::UInt8] img Image to write.
+    # @param [Integer] quality Image quality when jpeg write.
     def self.write(file_name, img, quality: 100)
       img_check(img)
       match_data = file_name.match(%r`(.*)/.+$`)
@@ -38,11 +45,17 @@ module DNN
       when /\.bmp$/i
         res = Stb.stbi_write_bmp(file_name, w, h, ch, bin)
       when /\.jpg$/i, /\.jpeg/i
+        raise TypeError, "quality:#{quality.class} is not an instance of Integer class." unless quality.is_a?(Integer)
+        raise ArgumentError, "quality should be between 1 and 100." unless quality.between?(1, 100)
         res = Stb.stbi_write_jpg(file_name, w, h, ch, bin, quality)
       end
       raise ImageWriteError.new("Image write failed.") if res == 0
     end
 
+    # Resize the image.
+    # @param [Numo::UInt8] img Image to resize.
+    # @param [Integer] out_height Image height to resize.
+    # @param [Integer] out_width Image width to resize.
     def self.resize(img, out_height, out_width)
       img_check(img)
       in_height, in_width, ch = *img.shape
@@ -51,12 +64,20 @@ module DNN
       img2
     end
 
+    # Trimming the image.
+    # @param [Numo::UInt8] img Image to resize.
+    # @param [Integer] y The begin y coordinate of the image to trimming.
+    # @param [Integer] x The begin x coordinate of the image to trimming.
+    # @param [Integer] height Image height to trimming.
+    # @param [Integer] width Image height to trimming.
     def self.trim(img, y, x, height, width)
       img_check(img)
       img[y...(y + height), x...(x + width), true].clone
     end
 
-    def self.gray_scale(img)
+    # Image convert to gray scale.
+    # @param [Numo::UInt8] img Image to gray scale.
+    def self.to_gray_scale(img)
       img_check(img)
       if img.shape[2] == RGB
         x = Numo::SFloat.cast(img)

data/lib/dnn/version.rb

@@ -1,3 +1,3 @@
 module DNN
-  VERSION = "0.13.4"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dnn
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 0.14.0
 platform: ruby
 authors:
 - unagiootoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -115,6 +115,7 @@ files:
 - ext/rb_stb_image/rb_stb_image.c
 - lib/dnn.rb
 - lib/dnn/core/activations.rb
+- lib/dnn/core/callbacks.rb
 - lib/dnn/core/cnn_layers.rb
 - lib/dnn/core/embedding.rb
 - lib/dnn/core/error.rb
@@ -132,6 +133,7 @@ files:
 - lib/dnn/core/regularizers.rb
 - lib/dnn/core/rnn_layers.rb
 - lib/dnn/core/savers.rb
+- lib/dnn/core/tensor.rb
 - lib/dnn/core/utils.rb
 - lib/dnn/datasets/cifar10.rb
 - lib/dnn/datasets/cifar100.rb