rumale 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d03b8ff82c4f925199c9fb8ecad244b837ce9d7
+  data.tar.gz: 4d220dba1d0e801333dfc806d99ae3318fe43862
+SHA512:
+  metadata.gz: 2f138a4f5e7c639de3f88d5e7c2e3191e1d66442c36d1d523390147f79bfbfbd35ce8ac1827c7cf0d34c93002d7c96c999627e699e5200a9707a77c4d9367f30
+  data.tar.gz: 64ba250cf66c3c5fec78d52d88976bfdeebdeda76570fe33dd5c9fd61e3e48e4c6c7d2103cc61b3573486a651aa390b9a4b5e2adb9c42a9aec2e03e14494bd18

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.swp
+.DS_Store
+.ruby-version
+/spec/dump_dbl.t
+/spec/dump_int.t
+/spec/dump_mult_dbl.t
+/spec/dump_zb.t

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 145
+  IgnoredPatterns: ['(\A|\s)#']
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+ParameterLists:
+  Max: 10
+
+Security/MarshalLoad:
+  Enabled: false
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,58 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-06-10 12:21:53 +0900 using RuboCop version 0.57.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/ClosingHeredocIndentation:
+  Exclude:
+    - 'rumale.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'rumale.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingBlankLines:
+  Exclude:
+    - 'rumale.gemspec'
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 29
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+os: linux
+dist: trusty
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+before_install:
+  - travis_retry gem update --system || travis_retry gem update --system 2.7.8
+  - travis_retry gem install bundler --no-document || travis_retry gem install bundler --no-document -v 1.17.3
+

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.8.0
+- Rename SVMKit to Rumale.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yoshoku@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2017-2019 Atsushi Tatsuma
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,175 @@
+# Rumale
+
+[![Build Status](https://travis-ci.org/yoshoku/rumale.svg?branch=master)](https://travis-ci.org/yoshoku/rumale)
+[![Coverage Status](https://coveralls.io/repos/github/yoshoku/rumale/badge.svg?branch=master)](https://coveralls.io/github/yoshoku/rumale?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rumale.svg)](https://badge.fury.io/rb/rumale)
+[![BSD 2-Clause License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/yoshoku/rumale/blob/master/LICENSE.txt)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/rumale/)
+
+Rumale (**Ru**by **ma**chine **le**arning) is a machine learninig library in Ruby.
+Rumale provides machine learning algorithms with interfaces similar to Scikit-Learn in Python.
+Rumale supports Linear / Kernel Support Vector Machine,
+Logistic Regression, Linear Regression, Ridge, Lasso, Factorization Machine,
+Naive Bayes, Decision Tree, AdaBoost, Random Forest, K-nearest neighbor classifier,
+K-Means, DBSCAN, Principal Component Analysis, and Non-negative Matrix Factorization.
+
+This project was formerly known as "[SVMKit](https://github.com/yoshoku/svmkit)".
+If you are using SVMKit, please install Rumale and replace `SVMKit` constants with `Rumale`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rumale'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rumale
+
+## Usage
+
+### Example 1. Pendigits dataset classification
+
+Rumale provides function loading libsvm format dataset file.
+We start by downloading the pendigits dataset from LIBSVM Data web site.
+
+```bash
+$ wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/pendigits
+$ wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/pendigits.t
+```
+
+Training of the classifier with Linear SVM and RBF kernel feature map is the following code.
+
+```ruby
+require 'rumale'
+
+# Load the training dataset.
+samples, labels = Rumale::Dataset.load_libsvm_file('pendigits')
+
+# Map training data to RBF kernel feature space.
+transformer = Rumale::KernelApproximation::RBF.new(gamma: 0.0001, n_components: 1024, random_seed: 1)
+transformed = transformer.fit_transform(samples)
+
+# Train linear SVM classifier.
+classifier = Rumale::LinearModel::SVC.new(reg_param: 0.0001, max_iter: 1000, batch_size: 50, random_seed: 1)
+classifier.fit(transformed, labels)
+
+# Save the model.
+File.open('transformer.dat', 'wb') { |f| f.write(Marshal.dump(transformer)) }
+File.open('classifier.dat', 'wb') { |f| f.write(Marshal.dump(classifier)) }
+```
+
+Classifying testing data with the trained classifier is the following code.
+
+```ruby
+require 'rumale'
+
+# Load the testing dataset.
+samples, labels = Rumale::Dataset.load_libsvm_file('pendigits.t')
+
+# Load the model.
+transformer = Marshal.load(File.binread('transformer.dat'))
+classifier = Marshal.load(File.binread('classifier.dat'))
+
+# Map testing data to RBF kernel feature space.
+transformed = transformer.transform(samples)
+
+# Classify the testing data and evaluate prediction results.
+puts("Accuracy: %.1f%%" % (100.0 * classifier.score(transformed, labels)))
+
+# Other evaluating approach
+# results = classifier.predict(transformed)
+# evaluator = Rumale::EvaluationMeasure::Accuracy.new
+# puts("Accuracy: %.1f%%" % (100.0 * evaluator.score(results, labels)))
+```
+
+Execution of the above scripts result in the following.
+
+```bash
+$ ruby train.rb
+$ ruby test.rb
+Accuracy: 98.4%
+```
+
+### Example 2. Cross-validation
+
+```ruby
+require 'rumale'
+
+# Load dataset.
+samples, labels = Rumale::Dataset.load_libsvm_file('pendigits')
+
+# Define the estimator to be evaluated.
+lr = Rumale::LinearModel::LogisticRegression.new(reg_param: 0.0001, random_seed: 1)
+
+# Define the evaluation measure, splitting strategy, and cross validation.
+ev = Rumale::EvaluationMeasure::LogLoss.new
+kf = Rumale::ModelSelection::StratifiedKFold.new(n_splits: 5, shuffle: true, random_seed: 1)
+cv = Rumale::ModelSelection::CrossValidation.new(estimator: lr, splitter: kf, evaluator: ev)
+
+# Perform 5-cross validation.
+report = cv.perform(samples, labels)
+
+# Output result.
+mean_logloss = report[:test_score].inject(:+) / kf.n_splits
+puts("5-CV mean log-loss: %.3f" % mean_logloss)
+```
+
+### Example 3. Pipeline
+
+```ruby
+require 'rumale'
+
+# Load dataset.
+samples, labels = Rumale::Dataset.load_libsvm_file('pendigits')
+
+# Construct pipeline with kernel approximation and SVC.
+rbf = Rumale::KernelApproximation::RBF.new(gamma: 0.0001, n_components: 800, random_seed: 1)
+svc = Rumale::LinearModel::SVC.new(reg_param: 0.0001, max_iter: 1000, random_seed: 1)
+pipeline = Rumale::Pipeline::Pipeline.new(steps: { trns: rbf, clsf: svc })
+
+# Define the splitting strategy and cross validation.
+kf = Rumale::ModelSelection::StratifiedKFold.new(n_splits: 5, shuffle: true, random_seed: 1)
+cv = Rumale::ModelSelection::CrossValidation.new(estimator: pipeline, splitter: kf)
+
+# Perform 5-cross validation.
+report = cv.perform(samples, labels)
+
+# Output result.
+mean_accuracy = report[:test_score].inject(:+) / kf.n_splits
+puts("5-CV mean accuracy: %.1f %%" % (mean_accuracy * 100.0))
+```
+
+Execution of the above scripts result in the following.
+
+```bash
+$ ruby pipeline.rb
+5-CV mean accuracy: 99.2 %
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/yoshoku/Rumale.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [BSD 2-clause License](https://opensource.org/licenses/BSD-2-Clause).
+
+## Code of Conduct
+
+Everyone interacting in the Rumale project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/Rumale/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec