data_modeler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7be4c7a2b2fcc56f06898a1fa67fc3494d8560c5
-  data.tar.gz: 27c3a704d5827dc86cac1f27652b178732fa8451
+  metadata.gz: 023a9053513981d2058cd23f7b0a9154da588b6b
+  data.tar.gz: 5e7a9c83204a2da747aa273e1ced42b4d1fefe36
 SHA512:
-  metadata.gz: e7a0847efa67279ca0aeb8ce808ed8cc4aef8c89e430fb857fd766524e66615a06548907a578982c8cc4f2fdab4ac1764d7af9674ca7667ff7945b81eb7fcc50
-  data.tar.gz: 2c5701cb6d89e66258baf0ef8883cb63a02a1c21dccc2cc810d737f9802ef3b725980e02a6982f057e4bad9805fe00ac1dbc73db97222ad152dd5eb550a59e6c
+  metadata.gz: 70cbccdd7cd7c9a70142c853f2a68e2a9be28412b05c48d6cd0b0440b703d6f878cdb58b1b0902efab321b4064116968aab37288ae2618634e44fc689ce0c433
+  data.tar.gz: 5d6ddf4e31fe4ae1d18973bf6719378037e9899d51627fdfc607813d8fff7de362d30aff0b4cb97343e13078414fde6a4a52e806e21f96fd572a0dfef740552e

data/lib/data_modeler/dataset/dataset.rb

@@ -82,9 +82,11 @@ class DataModeler::Dataset
   include DataModeler::IteratingBasedOnNext # `#each` and `#to_a` based on `#next`
 
   # Overloaded comparison for easier testing
+  # @param other [Dataset] what needs comparing to
+  # @return [void]
   def == other
-    self.class == other.class &&
-      data.object_id == other.data.object_id &&
+    self.class == other.class && # terminate check here if wrong class
+      data.object_id == other.data.object_id && # both `data` point to same object
       (instance_variables - [:@data]).all? do |var|
         self.instance_variable_get(var) == other.instance_variable_get(var)
       end
@@ -94,6 +96,8 @@ class DataModeler::Dataset
 
   include DataModeler::ConvertingTimeAndIndices # `#time` and `#idx`
 
+  # Initializes input indices vector
+  # @return [Array<input_idx>]
   def init_inputs
     if target_idx < end_idx
       # build list of incremental time buffers

data/lib/data_modeler/dataset/dataset_gen.rb

@@ -98,6 +98,7 @@ class DataModeler::DatasetGen
 
   # Check if there is enough data to build `min_nruns` train + test sets
   # @raise [NotEnoughDataError] if `not enough minerals` (cit.)
+  # @return [void]
   # @note remember the schema: need to check for `|win|train1|t1|t2|...|tn|`
   def validate_enough_data_for min_nruns
     min_data_size = min_eligible_trg + train_size + min_nruns * test_size

data/lib/data_modeler/model/fann.rb

@@ -5,6 +5,10 @@ class DataModeler::Model::FANN
 
   attr_reader :opts, :fann, :algo, :actfn
 
+  # @param netstruct [Array<ninputs, Array<hidden_layers>, noutputs>] network
+  #     structure
+  # @param algo [:incremental, :batch, :rprop, :quickprop] training algorithm
+  # @param actfn [:sigmoid, ...] activation function
   def initialize netstruct, algo: nil, actfn: nil
     ninputs, hidden_layers, noutputs = netstruct
     @opts = {
@@ -14,23 +18,25 @@ class DataModeler::Model::FANN
     }
     @algo = algo
     @actfn = actfn
+    reset
   end
 
+  # Resets / initializes the model
+  # @return [void]
   def reset
     @fann = RubyFann::Standard.new opts
-
-    if algo
-      fann.set_training_algorithm(algo)
-    end
-
+    fann.set_training_algorithm(algo) if algo
     if actfn
       fann.set_activation_function_hidden(actfn)
       fann.set_activation_function_output(actfn)
     end
-
-    return self # allows chaining for `model.reset.train`
+    nil
   end
 
+  # Trains the model for ngens on the trainset
+  # @param ngens [Integer] number of training generations
+  # @param trainset [Hash-like<input: Array, target: Array>] training set
+  # @return [void]
   def train ngens, trainset
     tset = RubyFann::TrainData.new(
       inputs: trainset[:input], desired_outputs: trainset[:target])
@@ -40,13 +46,19 @@ class DataModeler::Model::FANN
     fann.train_on_data(tset, ngens, 1000, 1e-10)
   end
 
+  # Tests the model on inputs.
+  # @param inputs [Array<Array<inputs>>] sequence of inputs for the model
+  # @return [Array<Array<outputs>>] outputs corresponding to each input
   def test inputs
     inputs.collect { |i| fann.run i }
   end
 
+  # Save the model
+  # @param filename [String/path] where to save the model
+  # @return [void]
   def save filename
     # can do filename check here...?
-    # I'd rather have kind of a `to_s`, and do the saving in the modeler
+    # TODO: I'd like to have a kind of `to_s`, and do all the saving in the modeler...
     fann.save filename
   end
 end

data/lib/data_modeler/version.rb

@@ -1,5 +1,5 @@
 # Main gem module
 module DataModeler
   # Version number
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_modeler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Giuseppe Cuccu