newral 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9047684d474438632d4eab4774fbb7b9debecc5
-  data.tar.gz: 0d83a2232560366d75af79b848fbbb8ba358169d
+  metadata.gz: bf672d40895fe65b38d8c889a7097d917e2cee5d
+  data.tar.gz: 48485e1ae8a01a21872faabfeb1ba37dc4bb9c60
 SHA512:
-  metadata.gz: 27e1bca6445adcc1d518d898e2e0e027d0d573eaba8bae588a9350a6d676d285afa549a9bc2a1ac07019f44645dc6cf8516b389069f50bf03ff8c3b322a0b0ea
-  data.tar.gz: 505f5faa6a843b4b5ab9e2c6654f6a8c32aa692bcf73d5058f95b3167a30c649979f250bbb17720d119e06a4aae5a4224a6d40ee53931607ca5caca3a061f9ed
+  metadata.gz: 959edca123d309747764650211098e93426f4b718fb87e4fa0c6060e47ec4e6332299c2c9cea7586e8901fd600cfef1bb5a17240d25ce1ff0100d51a4d01a7a8
+  data.tar.gz: 7af4b2733bf287fa4efb3ddd9ce7e7641cc7bbe076c8c30eaa563a166b6ced77e9a958028031fcfa22b5d52f2beaeb7a0c3c87ccd5dfa55a4af1153470131743

data/lib/newral/classifier/dendogram.rb

@@ -1,7 +1,8 @@
 module Newral
 
   module Classifier
-        
+    
+    # https://en.wikipedia.org/wiki/Dendrogram
     class Dendogram 
       attr_reader :nodes, :max_distance, :distances
       def initialize( points, max_runs: 100, abort_at_distance: 0.5 )

data/lib/newral/classifier/node.rb

@@ -46,7 +46,9 @@ module Newral
             end
           end.flatten
         end 
-  
+        
+        # a dendogram can produce very nested node sets, so you can also 
+        # flatten them by converting them to a cluster 
         def to_cluster 
           points = flatten_points
           Data::Cluster.new( points: points.collect{|p| p.to_a } )

data/lib/newral/data/idx.rb

@@ -8,6 +8,7 @@ module Newral
     end 
 
     class Idx < Base
+      # reads the MNIST data set fornat 
       # http://yann.lecun.com/exdb/mnist/
       # used for Handwritten Images
       def initialize( file_name: nil, label_file_name: nil )

data/lib/newral/functions/base.rb

@@ -5,6 +5,8 @@ module  Newral
       class NotImplemented < ::StandardError; end 
     end 
 
+    # the idea of having function classes is to have a common interface
+    # when the functions are optimized in training algorithms 
     class Base
       attr_accessor :center
      

data/lib/newral/functions/block.rb

@@ -5,6 +5,8 @@ module  Newral
     end 
     attr_reader :calculate_block
     # as its ruby we of course have to also offer the possibility for blocks
+    # the block is called in calculate, always passing the current @params values
+    # however for more complex examples you should rather derive from Base 
     class Block < Base
       
       def initialize( directions:0, params:[], &block )
@@ -19,7 +21,7 @@ module  Newral
       end
 
       def move( direction: 0, step:0.01, step_percentage: nil )
-        raise Errors::InvalidDirection unless direction >0 && direction<@directions
+        raise Errors::InvalidDirection unless direction >=0 && direction<@directions
         @params[direction]=(step_percentage ? @params[direction]*(1+step_percentage.to_f/100) : @params[direction]+step )
         self
       end

data/lib/newral/functions/line.rb

@@ -1,7 +1,7 @@
 module  Newral
   module Functions
-   
-
+          
+    # line is very simple, easiest to start getting familiar with gradient descent
     class Line < Base
       attr_accessor :center
      

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newral
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
 platform: ruby
 authors:
 - stefan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler