uranai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a799e4a46726580878537ac459dfcf49da77b94
+  data.tar.gz: abc37c0a3ad0669e60e1974ccacbbc5001b208bf
+SHA512:
+  metadata.gz: 292c257928957bcc13b6dcbab17084784808225f5c4f3a01cbaa21101e6c0d268fde3f2ea5693674fc0450121781ce4fda1c27c1a53cfdc32ee7c71a122b0d99
+  data.tar.gz: 4f038e3a64712bbee9b6a157b360a83abf308f1dc72adda9ed68ffd25600ffca57b4d357a2890bf79427e4671a85f8b4548bf5703867105d8b160a365be1a565

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uranai.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Teerawat Lamanchart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Uranai
+
+A library for solving **Supervised Learning**  (***regression*** & ***classification***) problems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'uranai'
+```
+And then execute:
+```shell
+$ bundle
+```
+Or install it yourself as:
+```shell
+$ gem install uranai
+```
+
+## Linear Regression Example:
+
+```ruby
+# Instantiates a linear regression instance.
+linear_regression = Uranai::LinearRegression.new("data.csv")
+
+# Computes cost (using cost function) with `default_theta`.
+initial_cost = linear_regression.compute_cost
+
+# Computes cost (using cost function) with custom theta.
+custom_cost = linear_regression.compute_cost(theta: [0.5, 0.5])
+
+# Finds fitting parameters.
+fitting_params = linear_regression.fitting_params
+
+# Predicts the result from given data.
+result = fitting_params.predict([3.5])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/teerawat1992/uranai.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uranai"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/uranai/data.rb

@@ -0,0 +1,42 @@
+require "csv"
+
+module Uranai
+  class Data
+    def initialize(csv)
+      @data = CSV.read(csv).map { |arr| arr.map(&:to_f) }.transpose
+    end
+
+    def column_size
+      data.length
+    end
+
+    def row_size
+      data.transpose.length
+    end
+    alias :training_example_size :row_size
+
+    def feature_size
+      column_size - 1
+    end
+
+    def x
+      data[0...column_size-1].insert(0, [1] * row_size)
+    end
+
+    def matrix_x
+      Matrix.columns(x)
+    end
+
+    def y
+      [data[-1]]
+    end
+
+    def matrix_y
+      Matrix.columns(y)
+    end
+
+    private
+
+    attr_reader :data
+  end
+end

data/lib/uranai/fitting_parameter.rb

@@ -0,0 +1,31 @@
+module Uranai
+  class FittingParameter
+    attr_reader :params
+    alias :values :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def predict(input_data)
+      check(input_data) do
+        params
+          .zip(input_data.insert(0, 1))
+          .map { |n1,n2| n1 * n2 }
+          .reduce(:+)
+      end
+    end
+
+    private
+
+    def check(data)
+      raise "input data must be Array" unless data.kind_of?(Array)
+      raise "input data size must be equal to feature size (#{feature_size})" if data.length != feature_size
+      yield
+    end
+
+    def feature_size
+      params.length - 1
+    end
+  end
+end

data/lib/uranai/linear_regression.rb

@@ -0,0 +1,63 @@
+require "matrix"
+require "uranai/data"
+require "uranai/fitting_parameter"
+
+module Uranai
+  class LinearRegression
+    def initialize(csv)
+      @data = Uranai::Data.new(csv)
+    end
+
+    def compute_cost(theta: default_theta)
+      matrix_theta = Matrix.columns(normalize_theta(theta))
+      ((matrix_x * matrix_theta) - matrix_y)
+        .map { |element| element ** 2 }
+        .inject(0.0) { |sum,i| sum + i }
+        ./ (2 * data.training_example_size)
+    end
+
+    def fitting_params_with_gradient_descent(options = {})
+      options.keep_if { |k,_| [:alpha, :num_iters, :theta, :normalize].include?(k) }
+      FittingParameter.new(gradient_descent(options))
+    end
+    alias :fitting_params :fitting_params_with_gradient_descent
+
+    def fitting_params_with_normal_equations
+      FittingParameter.new(normal_equations)
+    end
+
+    private
+
+    attr_reader :data
+
+    def default_theta
+      [[0] * data.column_size]
+    end
+
+    def normalize_theta(theta)
+      [theta.flatten]
+    end
+
+    def matrix_x
+      data.matrix_x
+    end
+
+    def matrix_y
+      data.matrix_y
+    end
+
+    # TODO: Add an option for normalizing feature data (x data)
+    def gradient_descent(alpha: 0.01, num_iters: 1500, theta: default_theta, normalize: false)
+      matrix_theta = Matrix.columns(normalize_theta(theta))
+      num_iters.times do
+        matrix_theta -= (matrix_x.transpose * ((matrix_x * matrix_theta) - matrix_y)) * (alpha / data.training_example_size)
+      end
+      matrix_theta.to_a.flatten
+    end
+
+    def normal_equations
+      ((matrix_x.transpose * matrix_x).inverse * matrix_x.transpose * matrix_y)
+        .to_a.flatten
+    end
+  end
+end

data/lib/uranai/version.rb

@@ -0,0 +1,3 @@
+module Uranai
+  VERSION = "0.1.0"
+end

data/lib/uranai.rb

@@ -0,0 +1,2 @@
+require "uranai/linear_regression"
+require "uranai/version"

data/uranai.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uranai/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uranai"
+  spec.version       = Uranai::VERSION
+  spec.authors       = ["Teerawat Lamanchart"]
+  spec.email         = ["teerawat.lamanchart@gmail.com"]
+
+  spec.summary       = %q{Machine Learning for Ruby}
+  spec.description   = %q{A library for solving Supervised Learning (regression & classification) problems}
+  spec.homepage      = "https://github.com/teerawat1992/uranai"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: uranai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Teerawat Lamanchart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A library for solving Supervised Learning (regression & classification)
+  problems
+email:
+- teerawat.lamanchart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uranai.rb
+- lib/uranai/data.rb
+- lib/uranai/fitting_parameter.rb
+- lib/uranai/linear_regression.rb
+- lib/uranai/version.rb
+- uranai.gemspec
+homepage: https://github.com/teerawat1992/uranai
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Machine Learning for Ruby
+test_files: []