rumale-svm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2fa12724b67f4cc5be042e64a8d29284e2292f23a5b13031e4b2ee33397285a
-  data.tar.gz: 453907d44a6113bf65531ec39e9d6da219bd1c2d0822cc6c72a1188e1b1e0b5e
+  metadata.gz: fb3d059168c39ad2dd1dc2052528b060f0b469165f3d5e60db3a6959a1994637
+  data.tar.gz: 3a7fa1c8d7445573308413e195426b294ad01c97fec59c345b46bf74b5ff8096
 SHA512:
-  metadata.gz: 490675646f497293d10112605ab1d5dcbc1a69a21e67f2712b304b89d7e542e9894358e536dec4811e04ead3bb94fbd77c5273a7e3464cc883e9e50e8212af0b
-  data.tar.gz: 9ccac4d7d7cf56deac34f9c9c731e3b6c455df65ca7349ed0634c37106ea0e6fe42dec243459f966e87c3aadf72525211fa4c365925c59f6089024689968c9be
+  metadata.gz: 88191bf03ef5ade4eb9d6d927ccbf53a2f0e74789aebbe9616dea472548a28e8e46a0fb6e0a0903c67e84f919e22903830c39cbe8f2a761a183b2a429836ddda
+  data.tar.gz: a6897776e03bb756f40138984537353ac42643006892fa4ef61d89950478f074f530d0dc57192185f4f72d30768b83619d9cd813a3dab3bdecab5e6034eddb9f

data/.travis.yml

@@ -1,5 +1,4 @@
 ---
-sudo: false
 os: linux
 dist: bionic
 language: ruby

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.4.0
+- Add linear one-class support vector machine.
+
 # 0.3.0
 - Fix to raise error when calling prediction method before training model.
 - Fix some config files.

data/README.md

@@ -77,12 +77,6 @@ $ ruby rumale_svm_test.rb
 Accuracy: 0.835
 ```
 
-## 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-svm. 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.

data/lib/rumale/svm.rb

@@ -9,3 +9,4 @@ require 'rumale/svm/one_class_svm'
 require 'rumale/svm/linear_svc'
 require 'rumale/svm/linear_svr'
 require 'rumale/svm/logistic_regression'
+require 'rumale/svm/linear_one_class_svm'

data/lib/rumale/svm/linear_one_class_svm.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'numo/liblinear'
+require 'rumale/base/base_estimator'
+require 'rumale/validation'
+
+module Rumale
+  module SVM
+    # LinearOneClassSVM is a class that provides linear One-class Support Vector Machine in LIBLINEAR with Rumale interface.
+    #
+    # @example
+    #   estimator = Rumale::SVM::LinearOneClassSVM.new(nu: 0.05, random_seed: 1)
+    #   estimator.fit(training_samples, traininig_labels)
+    #   results = estimator.predict(testing_samples)
+    class LinearOneClassSVM
+      include Base::BaseEstimator
+      include Validation
+
+      # Return the weight vector for LinearOneClassSVM.
+      # @return [Numo::DFloat] (shape: [n_features])
+      attr_reader :weight_vec
+
+      # Return the bias term (a.k.a. intercept) for LinearOneClassSVM.
+      # @return [Float]
+      attr_reader :bias_term
+
+      # Create a new estimator with linear One-class Support Vector Machine.
+      #
+      # @param nu [Float] The fraction of data as outliers. The interval of nu is (0, 1].
+      # @param reg_param [Float] The regularization parameter.
+      # @param tol [Float] The tolerance of termination criterion.
+      # @param verbose [Boolean] The flag indicating whether to output learning process message
+      # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
+      def initialize(nu: 0.05, reg_param: 1.0, tol: 1e-3, verbose: false, random_seed: nil)
+        check_params_numeric(nu: nu, reg_param: reg_param, tol: tol)
+        check_params_boolean(verbose: verbose)
+        check_params_numeric_or_nil(random_seed: random_seed)
+        @params = {}
+        @params[:nu] = nu.to_f
+        @params[:reg_param] = reg_param.to_f
+        @params[:tol] = tol.to_f
+        @params[:verbose] = verbose
+        @params[:random_seed] = random_seed.nil? ? nil : random_seed.to_i
+        @weight_vec = nil
+        @bias_term = nil
+        @model = nil
+      end
+
+      # Fit the model with given training data.
+      #
+      # @overload fit(x) -> LinearOneClassSVM
+      #   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The training data to be used for fitting the model.
+      #
+      # @return [LinearOneClassSVM] The learned estimator itself.
+      def fit(x, _y = nil)
+        x = check_convert_sample_array(x)
+        dummy = Numo::DFloat.ones(x.shape[0])
+        @model = Numo::Liblinear.train(x, dummy, liblinear_params)
+        @weight_vec = @model[:w].dup
+        @bias_term = @model[:rho]
+        self
+      end
+
+      # Calculate confidence scores for samples.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to compute the scores.
+      # @return [Numo::DFloat] (shape: [n_samples, n_classes]) Confidence score per sample.
+      def decision_function(x)
+        raise "#{self.class.name}\##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = check_convert_sample_array(x)
+        Numo::Liblinear.decision_function(x, liblinear_params, @model)
+      end
+
+      # Predict class labels for samples.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the labels.
+      # @return [Numo::Int32] (shape: [n_samples]) Predicted label per sample.
+      def predict(x)
+        raise "#{self.class.name}\##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = check_convert_sample_array(x)
+        Numo::Int32.cast(Numo::Liblinear.predict(x, liblinear_params, @model))
+      end
+
+      # Dump marshal data.
+      # @return [Hash] The marshal data about LinearOneClassSVM.
+      def marshal_dump
+        { params: @params,
+          model: @model,
+          weight_vec: @weight_vec,
+          bias_term: @bias_term }
+      end
+
+      # Load marshal data.
+      # @return [nil]
+      def marshal_load(obj)
+        @params = obj[:params]
+        @model = obj[:model]
+        @weight_vec = obj[:weight_vec]
+        @bias_term = obj[:bias_term]
+        nil
+      end
+
+      private
+
+      def liblinear_params
+        res = {}
+        res[:solver_type] = Numo::Liblinear::SolverType::ONECLASS_SVM
+        res[:eps] = @params[:tol]
+        res[:C] = @params[:reg_param]
+        res[:nu] = @params[:nu]
+        res[:verbose] = @params[:verbose]
+        res[:random_seed] = @params[:random_seed]
+        res
+      end
+
+      def trained?
+        !@model.nil?
+      end
+    end
+  end
+end

data/lib/rumale/svm/version.rb

@@ -5,6 +5,6 @@ module Rumale
   # This module consists of Rumale interfaces for suppor vector machine algorithms with LIBSVM and LIBLINEAR.
   module SVM
     # The version of Rumale-SVM you are using.
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/rumale-svm.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'numo-liblinear', '~> 1.0'
+  spec.add_runtime_dependency 'numo-liblinear', '~> 1.1'
   spec.add_runtime_dependency 'numo-libsvm', '~> 1.0'
   spec.add_runtime_dependency 'rumale', '~> 0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumale-svm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-liblinear
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: numo-libsvm
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +63,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
-- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -74,9 +73,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/rumale/svm.rb
+- lib/rumale/svm/linear_one_class_svm.rb
 - lib/rumale/svm/linear_svc.rb
 - lib/rumale/svm/linear_svr.rb
 - lib/rumale/svm/logistic_regression.rb

data/.github/workflows/build.yml

@@ -1,24 +0,0 @@
-name: build
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby: ['2.4.x', '2.5.x', '2.6.x']
-
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby
-      uses: actions/setup-ruby@master
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rumale/svm"
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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