rumale-svm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 94a681354e720d47b0efe86bb2833b4ecdb1c3ff
-  data.tar.gz: 050ae3bb322c3a89ebbceb1b5e114988738a9404
+SHA256:
+  metadata.gz: e2fa12724b67f4cc5be042e64a8d29284e2292f23a5b13031e4b2ee33397285a
+  data.tar.gz: 453907d44a6113bf65531ec39e9d6da219bd1c2d0822cc6c72a1188e1b1e0b5e
 SHA512:
-  metadata.gz: 3fe3c396ce596b589b508ecbce62258f14ef3733eb26d9d5829bad81c4bba2380fbf143178e1daabf0d9f523118099a0d56ed285bc5407da1c6af10e56283e23
-  data.tar.gz: fa78aa2cb873c8246b9ddc3c75063ae00ba9acf8c644d87b33900e16a813b870f2cffde7159625e695a1c0a3874d48a9302dca93e3670e25d05ba0caa180656c
+  metadata.gz: 490675646f497293d10112605ab1d5dcbc1a69a21e67f2712b304b89d7e542e9894358e536dec4811e04ead3bb94fbd77c5273a7e3464cc883e9e50e8212af0b
+  data.tar.gz: 9ccac4d7d7cf56deac34f9c9c731e3b6c455df65ca7349ed0634c37106ea0e6fe42dec243459f966e87c3aadf72525211fa4c365925c59f6089024689968c9be

data/.rubocop.yml

@@ -0,0 +1,107 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'bin/*'
+    - 'rumale-svm.gemspec'
+    - 'Rakefile'
+    - 'Gemfile'
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 145
+  IgnoredPatterns: ['(\A|\s)#']
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 16
+
+Metrics/PerceivedComplexity:
+  Max: 16
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  Max: 12
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 40
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false
+

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
   - '2.4'
   - '2.5'
   - '2.6'
+  - '2.7'
 
 before_install:
   - gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+- Fix to raise error when calling prediction method before training model.
+- Fix some config files.
+
 # 0.2.0
 - Supported the new Rumale's validation:
   - Fix to use new numeric validation for hyperparameter values.

data/Gemfile

@@ -1,4 +1,8 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rumale-svm.gemspec
 gemspec
+
+gem 'coveralls', '~> 0.8'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Atsushi Tatsuma
+Copyright (c) 2019-2020 Atsushi Tatsuma
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -4,7 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/yoshoku/rumale-svm/badge.svg?branch=master)](https://coveralls.io/github/yoshoku/rumale-svm?branch=master)
 [![Gem Version](https://badge.fury.io/rb/rumale-svm.svg)](https://badge.fury.io/rb/rumale-svm)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/rumale-svm/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://yoshoku.github.io/rumale-svm/doc/)
+[![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/rumale-svm/doc/)
 
 Rumale::SVM provides support vector machine algorithms in
 [LIBSVM](https://www.csie.ntu.edu.tw/~cjlin/libsvm/) and [LIBLINEAR](https://www.csie.ntu.edu.tw/~cjlin/liblinear/)
@@ -30,6 +30,10 @@ Or install it yourself as:
 
     $ gem install rumale-svm
 
+## Documentation
+
+- [Rumale::SVM API Documentation](https://yoshoku.github.io/rumale-svm/doc/)
+
 ## Usage
 Download pendigits dataset from [LIBSVM DATA](https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/) web page.
 

data/lib/rumale/svm/linear_svc.rb

@@ -85,6 +85,7 @@ module Rumale
       # @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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.decision_function(xx, liblinear_params, @model)
@@ -95,6 +96,7 @@ module Rumale
       # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the labels.
       # @return [Numo::Int32] (shape: [n_samples]) Predicted class 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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Int32.cast(Numo::Liblinear.predict(xx, liblinear_params, @model))
@@ -106,6 +108,7 @@ module Rumale
       # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the probailities.
       # @return [Numo::DFloat] (shape: [n_samples, n_classes]) Predicted probability of each class per sample.
       def predict_proba(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)
         if binary_class?
           probs = Numo::DFloat.zeros(x.shape[0], 2)
@@ -232,6 +235,10 @@ module Rumale
       def labels
         @model[:label]
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/linear_svr.rb

@@ -79,6 +79,7 @@ module Rumale
       # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the labels.
       # @return [Numo::DFloat] (shape: [n_samples]) Predicted value 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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.predict(xx, liblinear_params, @model)
@@ -145,6 +146,10 @@ module Rumale
       def bias_scale
         @params[:bias_scale]
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/logistic_regression.rb

@@ -77,6 +77,7 @@ module Rumale
       # @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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.decision_function(xx, liblinear_params, @model)
@@ -87,6 +88,7 @@ module Rumale
       # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the labels.
       # @return [Numo::Int32] (shape: [n_samples]) Predicted class 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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Int32.cast(Numo::Liblinear.predict(xx, liblinear_params, @model))
@@ -98,6 +100,7 @@ module Rumale
       # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the probailities.
       # @return [Numo::DFloat] (shape: [n_samples, n_classes]) Predicted probability of each class per sample.
       def predict_proba(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)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.predict_proba(xx, liblinear_params, @model)
@@ -184,6 +187,10 @@ module Rumale
       def n_features
         @model[:nr_feature]
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/nu_svc.rb

@@ -71,6 +71,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.decision_function(xx, libsvm_params, @model)
@@ -82,6 +83,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::Int32] (shape: [n_samples]) Predicted class 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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Int32.cast(Numo::Libsvm.predict(xx, libsvm_params, @model))
@@ -94,6 +96,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::DFloat] (shape: [n_samples, n_classes]) Predicted probability of each class per sample.
       def predict_proba(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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict_proba(xx, libsvm_params, @model)
@@ -188,6 +191,10 @@ module Rumale
         res[:eps] = res.delete(:tol)
         res
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/nu_svr.rb

@@ -69,6 +69,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::DFloat] (shape: [n_samples]) Predicted value 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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict(xx, libsvm_params, @model)
@@ -151,6 +152,10 @@ module Rumale
         res[:eps] = res.delete(:tol)
         res
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/one_class_svm.rb

@@ -67,6 +67,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @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::Libsvm.decision_function(x, libsvm_params, @model)
       end
@@ -77,6 +78,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @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::Libsvm.predict(x, libsvm_params, @model))
       end
@@ -145,6 +147,10 @@ module Rumale
         res[:eps] = res.delete(:tol)
         res
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/svc.rb

@@ -71,6 +71,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.decision_function(xx, libsvm_params, @model)
@@ -82,6 +83,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::Int32] (shape: [n_samples]) Predicted class 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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Int32.cast(Numo::Libsvm.predict(xx, libsvm_params, @model))
@@ -94,6 +96,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::DFloat] (shape: [n_samples, n_classes]) Predicted probability of each class per sample.
       def predict_proba(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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict_proba(xx, libsvm_params, @model)
@@ -189,6 +192,10 @@ module Rumale
         res[:eps] = res.delete(:tol)
         res
       end
+
+      def trained?
+        !@model.nil?
+      end
     end
   end
 end

data/lib/rumale/svm/svr.rb

@@ -72,6 +72,7 @@ module Rumale
       #   If the kernel is 'precomputed', the shape of x must be [n_samples, n_training_samples].
       # @return [Numo::DFloat] (shape: [n_samples]) Predicted value 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)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict(xx, libsvm_params, @model)
@@ -156,6 +157,10 @@ module Rumale
         res[:eps] = res.delete(:tol)
         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.2.0'
+    VERSION = '0.3.0'
   end
 end

data/rumale-svm.gemspec

@@ -34,8 +34,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'numo-liblinear', '~> 1.0'
   spec.add_runtime_dependency 'numo-libsvm', '~> 1.0'
   spec.add_runtime_dependency 'rumale', '~> 0.14'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumale-svm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-liblinear
@@ -52,62 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: 'Rumale-SVM provides support vector machine algorithms of LIBSVM and
   LIBLINEAR with Rumale interface.
 
@@ -122,6 +66,7 @@ files:
 - ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -150,7 +95,7 @@ metadata:
   source_code_uri: https://github.com/yoshoku/rumale-svm
   changelog_uri: https://github.com/yoshoku/rumale-svm/blob/master/CHANGELOG.md
   documentation_uri: https://yoshoku.github.io/rumale-svm/doc/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rumale-SVM provides support vector machine algorithms of LIBSVM and LIBLINEAR
   with Rumale interface.