ruby_linear_regression 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd88f39c66fb2efe50b976fe3b1f04e06b179d18
-  data.tar.gz: 83842d112a3d92d239a08422e750f616923b2942
+  metadata.gz: 7fdd3245c2d76d40b4e6a1992644360e0cab3d74
+  data.tar.gz: 3c02457473a0695ac8eae4803a8b04799e8ba4b0
 SHA512:
-  metadata.gz: a57cf9ee217bebd8ef47d417068c2abef876592d909fcf3359c05d11b12ebc7a4891cb583cd96193637c0cdbe6fe14278c92649377d860c8e32c33217a1d7a6e
-  data.tar.gz: 8f8aa53d404036c3ee657f94ad9d15f99f2ba9bf3da6b9854e10144fea7f87432e7ea2cf3bc9d8fe87a52c84121f242e472afc7a582407d6acfd0e088cd6fd0a
+  metadata.gz: bea431b65d547919c489aa894d34a20a4d70b41733c9eedc32fcd6447d8feb4cd951c084f12167281e88a442d99ba799b969437a732327f7fc5ee132eb4954bf
+  data.tar.gz: e5242100d48114b33da5ec3e729f2b554df7258a7738583440233d85030b00a7771e7946b27f55a9b58a725e29655c3659a27ef80264bec66c49e4fbc88a24e7

data/lib/ruby_linear_regression.rb

@@ -1,5 +1,6 @@
 require 'matrix'
 
+# RubyLinearRegression
 class RubyLinearRegression
 
   attr_reader :x,:y,:theta,:mu,:sigma
@@ -9,6 +10,10 @@ class RubyLinearRegression
     @sigma = 1
   end
 
+  # Loads and normalizes the training data, must be called prior to training.
+  # Arguments:
+  #   x_data: (Two dimensiolnal array with the independent variables of your training data)
+  #   y_data: (Array with the dependent variables of your training data)
   def load_training_data x_data, y_data
 
         # normalize the x_data
@@ -24,8 +29,8 @@ class RubyLinearRegression
         @theta = Matrix[[0],[0]]
   end
 
+  # Compute the mean squared cost / error function
   def compute_cost
-    # Compute the mean squared cost / error function
     # First use matrix multiplication and vector subtracton to find errors
     errors = (@x * @theta) - @y
 
@@ -38,6 +43,7 @@ class RubyLinearRegression
     return mean_square_error
   end
 
+  # Calculate the optimal theta using the normal equation
   def train_normal_equation
     # Calculate the optimal theta using the normal equation
     # theta = ( X' * X )^1 * X' * y
@@ -46,6 +52,11 @@ class RubyLinearRegression
     return @theta
   end
 
+  # Makes a prediction based on your trained model.
+  # train_normal_equation must be called prior to making a prediction.
+  #
+  # Arguments:
+  #   data: (Array of independent variables to base your prediction on)
   def predict data
 
     # normalize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_linear_regression
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Soren Blond Daugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-06-10 00:00:00.000000000 Z
 dependencies: []
 description: "An implementation of a linear regression machine learning algorithm
   implemented in Ruby.\n                This algorithm uses Ruby's Matrix implementation