RubyGems - rumale-svm - Versions diffs - 0.7.0 → 0.8.0 - Mend

rumale-svm 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +4 -1
data/README.md +0 -1
data/lib/rumale/svm/linear_one_class_svm.rb +8 -13
data/lib/rumale/svm/linear_svc.rb +14 -17
data/lib/rumale/svm/linear_svr.rb +10 -13
data/lib/rumale/svm/logistic_regression.rb +13 -17
data/lib/rumale/svm/nu_svc.rb +14 -17
data/lib/rumale/svm/nu_svr.rb +10 -13
data/lib/rumale/svm/one_class_svm.rb +11 -17
data/lib/rumale/svm/svc.rb +14 -17
data/lib/rumale/svm/svr.rb +10 -14
data/lib/rumale/svm/version.rb +1 -1
metadata +4 -10

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec0ef314d44123fa222655004b099652d244c7fb9bea73569a4fe701974e43b1
-  data.tar.gz: ccaca04e1b3fe7691467a26a678f8978bc2f77e5a1b2e094b1af08923779588b
+  metadata.gz: 5611ab7bee24d673f0803b5679532326389a9a485dd5beafeb9d448ab5538363
+  data.tar.gz: 033024146647d6ba5e4acf08eb876dc35e0fe25f141555891dec77e84cd6572b
 SHA512:
-  metadata.gz: 44b1ab01d131133ef5d9fb32ae4dfaff5ca1187e45c5a1b4f4ec3b198f515020baf85b5bb4a1bb110ae6e85d74f521af86661b4741a63828bd49288a138c9513
-  data.tar.gz: af83ab927ed5fbd630880b51fa2a0bf25c9aaad066a603d1ce6bf178c873ed669461eb46cdb23003b888799f11a5114fdf5405288d8129783c9495ec74799fd5
+  metadata.gz: b70772fd9480c0de3f28d477bdf35ccae3260f9a9d1156423cac8654caebbc1891a9182e1ee3a4b3b7add8ce885ac06c2e57e8d3ca46a71e9d7de99d46d1c33d
+  data.tar.gz: a38ccc2f952bb1e3fe5c4906e9225bb2d6c5c938b93aa6d08a8b66a2b20f4e94b0d96fe08c86f489050051eb149cdf68b74826b6a5f7439fbab5ee47de2b67e6

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,6 @@
+# 0.8.0
+- Refactor to support the new Rumale API.
 # 0.7.0
 - Support for probabilistic outputs with Rumale::SVM::OneClassSVM.
 - Update numo-libsvm depedency to v2.1 or higher.
@@ -6,7 +9,7 @@
 - Update numo-libsvm and numo-liblinear depedency to v2.0 or higher.
 # 0.5.1
-- Refator specs and config files.
+- Refactor specs and config files.
 # 0.5.0
 - Add type declaration files.

data/README.md CHANGED Viewed

@@ -1,7 +1,6 @@
 # Rumale::SVM
 [![Build Status](https://github.com/yoshoku/rumale-svm/workflows/build/badge.svg)](https://github.com/yoshoku/rumale-svm/actions?query=workflow%3Abuild)
-[![Coverage Status](https://coveralls.io/repos/github/yoshoku/rumale-svm/badge.svg?branch=main)](https://coveralls.io/github/yoshoku/rumale-svm?branch=main)
 [![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/main/LICENSE.txt)
 [![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/rumale-svm/doc/)

data/lib/rumale/svm/linear_one_class_svm.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'numo/liblinear'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/validation'
 module Rumale
@@ -12,10 +12,7 @@ module Rumale
     #   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
+    class LinearOneClassSVM < Rumale::Base::Estimator
       # Return the weight vector for LinearOneClassSVM.
       # @return [Numo::DFloat] (shape: [n_features])
       attr_reader :weight_vec
@@ -32,9 +29,7 @@ module Rumale
       # @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)
+        super()
         @params = {}
         @params[:nu] = nu.to_f
         @params[:reg_param] = reg_param.to_f
@@ -50,7 +45,7 @@ module Rumale
       #
       # @return [LinearOneClassSVM] The learned estimator itself.
       def fit(x, _y = nil)
-        x = check_convert_sample_array(x)
+        x = Rumale::Validation.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
@@ -63,8 +58,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         Numo::Liblinear.decision_function(x, liblinear_params, @model)
       end
@@ -73,8 +68,8 @@ module Rumale
       # @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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         Numo::Int32.cast(Numo::Liblinear.predict(x, liblinear_params, @model))
       end

data/lib/rumale/svm/linear_svc.rb CHANGED Viewed

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 require 'numo/liblinear'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/classifier'
 require 'rumale/probabilistic_output'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -13,9 +14,8 @@ module Rumale
     #   estimator = Rumale::SVM::LinearSVC.new(penalty: 'l2', loss: 'squared_hinge', reg_param: 1.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_labels)
     #   results = estimator.predict(testing_samples)
-    class LinearSVC
-      include Base::BaseEstimator
-      include Base::Classifier
+    class LinearSVC < Rumale::Base::Estimator
+      include Rumale::Base::Classifier
       # Return the weight vector for LinearSVC.
       # @return [Numo::DFloat] (shape: [n_classes, n_features])
@@ -43,10 +43,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(penalty: 'l2', loss: 'squared_hinge', dual: true, reg_param: 1.0,
                      fit_bias: true, bias_scale: 1.0, probability: false, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_string(penalty: penalty, loss: loss)
-        check_params_numeric(reg_param: reg_param, bias_scale: bias_scale, tol: tol)
-        check_params_boolean(dual: dual, fit_bias: fit_bias, probability: probability, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:penalty] = penalty == 'l1' ? 'l1' : 'l2'
         @params[:loss] = loss == 'hinge' ? 'hinge' : 'squared_hinge'
@@ -66,9 +63,9 @@ module Rumale
       # @param y [Numo::Int32] (shape: [n_samples]) The labels to be used for fitting the model.
       # @return [LinearSVC] The learned classifier itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_label_array(y)
-        check_sample_label_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_label_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = fit_bias? ? expand_feature(x) : x
         @model = Numo::Liblinear.train(xx, y, liblinear_params)
         @weight_vec, @bias_term = weight_and_bias(@model[:w])
@@ -81,8 +78,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.decision_function(xx, liblinear_params, @model)
       end
@@ -92,8 +89,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Int32.cast(Numo::Liblinear.predict(xx, liblinear_params, @model))
       end
@@ -104,8 +101,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         if binary_class?
           probs = Numo::DFloat.zeros(x.shape[0], 2)
           probs[true, 0] = 1.0 / (Numo::NMath.exp(@prob_param[0] * decision_function(x) + @prob_param[1]) + 1.0)

data/lib/rumale/svm/linear_svr.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/regressor'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -12,9 +13,8 @@ module Rumale
     #   estimator = Rumale::SVM::LinearSVR.new(reg_param: 1.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_target_values)
     #   results = estimator.predict(testing_samples)
-    class LinearSVR
-      include Base::BaseEstimator
-      include Base::Regressor
+    class LinearSVR < Rumale::Base::Estimator
+      include Rumale::Base::Regressor
       # Return the weight vector for LinearSVR.
       # @return [Numo::DFloat] (shape: [n_classes, n_features])
@@ -40,10 +40,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(loss: 'squared_epsilon_insensitive', dual: true, reg_param: 1.0, epsilon: 0.1,
                      fit_bias: true, bias_scale: 1.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_string(loss: loss)
-        check_params_numeric(reg_param: reg_param, epsilon: epsilon, bias_scale: bias_scale, tol: tol)
-        check_params_boolean(dual: dual, fit_bias: fit_bias, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:loss] = loss == 'epsilon_insensitive' ? 'epsilon_insensitive' : 'squared_epsilon_insensitive'
         @params[:dual] = dual
@@ -62,9 +59,9 @@ module Rumale
       # @param y [Numo::DFloat] (shape: [n_samples]) The target values to be used for fitting the model.
       # @return [LinearSVR] The learned regressor itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_tvalue_array(y)
-        check_sample_tvalue_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_target_value_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = fit_bias? ? expand_feature(x) : x
         @model = Numo::Liblinear.train(xx, y, liblinear_params)
         @weight_vec, @bias_term = weight_and_bias(@model[:w])
@@ -76,8 +73,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.predict(xx, liblinear_params, @model)
       end

data/lib/rumale/svm/logistic_regression.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'numo/liblinear'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/classifier'
 module Rumale
@@ -12,9 +12,8 @@ module Rumale
     #   estimator = Rumale::SVM::LogisticRegression.new(penalty: 'l2', dual: false, reg_param: 1.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_labels)
     #   results = estimator.predict(testing_samples)
-    class LogisticRegression
-      include Base::BaseEstimator
-      include Base::Classifier
+    class LogisticRegression < Rumale::Base::Estimator
+      include Rumale::Base::Classifier
       # Return the weight vector for LogisticRegression.
       # @return [Numo::DFloat] (shape: [n_classes, n_features])
@@ -39,10 +38,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(penalty: 'l2', dual: true, reg_param: 1.0,
                      fit_bias: true, bias_scale: 1.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_string(penalty: penalty)
-        check_params_numeric(reg_param: reg_param, bias_scale: bias_scale, tol: tol)
-        check_params_boolean(dual: dual, fit_bias: fit_bias, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:penalty] = penalty == 'l1' ? 'l1' : 'l2'
         @params[:dual] = dual
@@ -60,9 +56,9 @@ module Rumale
       # @param y [Numo::Int32] (shape: [n_samples]) The labels to be used for fitting the model.
       # @return [LogisticRegression] The learned classifier itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_label_array(y)
-        check_sample_label_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_label_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = fit_bias? ? expand_feature(x) : x
         @model = Numo::Liblinear.train(xx, y, liblinear_params)
         @weight_vec, @bias_term = weight_and_bias(@model[:w])
@@ -74,8 +70,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.decision_function(xx, liblinear_params, @model)
       end
@@ -85,8 +81,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Int32.cast(Numo::Liblinear.predict(xx, liblinear_params, @model))
       end
@@ -97,8 +93,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = fit_bias? ? expand_feature(x) : x
         Numo::Liblinear.predict_proba(xx, liblinear_params, @model)
       end

data/lib/rumale/svm/nu_svc.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/classifier'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -12,9 +13,8 @@ module Rumale
     #   estimator = Rumale::SVM::NuSVC.new(nu: 0.5, kernel: 'rbf', gamma: 10.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_labels)
     #   results = estimator.predict(testing_samples)
-    class NuSVC
-      include Base::BaseEstimator
-      include Base::Classifier
+    class NuSVC < Rumale::Base::Estimator
+      include Rumale::Base::Classifier
       # Create a new classifier with Kernel Nu-Support Vector Classifier.
       #
@@ -31,10 +31,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(nu: 0.5, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
                      shrinking: true, probability: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_numeric(nu: nu, degree: degree, gamma: gamma, coef0: coef0, cache_size: cache_size, tol: tol)
-        check_params_string(kernel: kernel)
-        check_params_boolean(shrinking: shrinking, probability: probability, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:nu] = nu.to_f
         @params[:kernel] = kernel
@@ -56,9 +53,9 @@ module Rumale
       # @param y [Numo::Int32] (shape: [n_samples]) The labels to be used for fitting the model.
       # @return [NuSVC] The learned classifier itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_label_array(y)
-        check_sample_label_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_label_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = precomputed_kernel? ? add_index_col(x) : x
         @model = Numo::Libsvm.train(xx, y, libsvm_params)
         self
@@ -70,8 +67,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.decision_function(xx, libsvm_params, @model)
       end
@@ -82,8 +79,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Int32.cast(Numo::Libsvm.predict(xx, libsvm_params, @model))
       end
@@ -95,8 +92,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict_proba(xx, libsvm_params, @model)
       end

data/lib/rumale/svm/nu_svr.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/regressor'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -12,9 +13,8 @@ module Rumale
     #   estimator = Rumale::SVM::NuSVR.new(nu: 0.5, kernel: 'rbf', gamma: 10.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_target_values)
     #   results = estimator.predict(testing_samples)
-    class NuSVR
-      include Base::BaseEstimator
-      include Base::Regressor
+    class NuSVR < Rumale::Base::Estimator
+      include Rumale::Base::Regressor
       # Create a new regressor with Kernel Nu-Support Vector Regressor.
       #
@@ -30,10 +30,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(nu: 0.5, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
                      shrinking: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_numeric(nu: nu, degree: degree, gamma: gamma, coef0: coef0, cache_size: cache_size, tol: tol)
-        check_params_string(kernel: kernel)
-        check_params_boolean(shrinking: shrinking, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:nu] = nu.to_f
         @params[:kernel] = kernel
@@ -54,9 +51,9 @@ module Rumale
       # @param y [Numo::DFloat] (shape: [n_samples]) The target values to be used for fitting the model.
       # @return [NuSVR] The learned regressor itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_tvalue_array(y)
-        check_sample_tvalue_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_target_value_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = precomputed_kernel? ? add_index_col(x) : x
         @model = Numo::Libsvm.train(xx, y, libsvm_params)
         self
@@ -68,8 +65,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict(xx, libsvm_params, @model)
       end

data/lib/rumale/svm/one_class_svm.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/validation'
 module Rumale
@@ -12,10 +12,7 @@ module Rumale
     #   estimator = Rumale::SVM::OneClassSVM.new(nu: 0.5, kernel: 'rbf', gamma: 10.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_labels)
     #   results = estimator.predict(testing_samples)
-    class OneClassSVM
-      include Base::BaseEstimator
-      include Validation
+    class OneClassSVM < Rumale::Base::Estimator
       # Create a new estimator with One-class Support Vector Machine.
       #
       # @param nu [Float] The regularization parameter. The interval of nu is (0, 1].
@@ -31,10 +28,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(nu: 1.0, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
                      shrinking: true, probability: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_numeric(nu: nu, degree: degree, gamma: gamma, coef0: coef0, cache_size: cache_size, tol: tol)
-        check_params_string(kernel: kernel)
-        check_params_boolean(shrinking: shrinking, probability: probability, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:nu] = nu.to_f
         @params[:kernel] = kernel
@@ -56,7 +50,7 @@ module Rumale
       #     If the kernel is 'precomputed', x must be a square distance matrix (shape: [n_samples, n_samples]).
       # @return [OneClassSVM] The learned estimator itself.
       def fit(x, _y = nil)
-        x = check_convert_sample_array(x)
+        x = Rumale::Validation.check_convert_sample_array(x)
         dummy = Numo::DFloat.ones(x.shape[0])
         @model = Numo::Libsvm.train(x, dummy, libsvm_params)
         self
@@ -68,8 +62,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         Numo::Libsvm.decision_function(x, libsvm_params, @model)
       end
@@ -79,8 +73,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         Numo::Int32.cast(Numo::Libsvm.predict(x, libsvm_params, @model))
       end
@@ -91,9 +85,9 @@ 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?
-        raise "#{self.class.name}\##{__method__} expects to be called after training the probablity parameters." unless trained_probs?
-        x = check_convert_sample_array(x)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        raise "#{self.class.name}##{__method__} expects to be called after training the probablity parameters." unless trained_probs?
+        x = Rumale::Validation.check_convert_sample_array(x)
         Numo::Libsvm.predict_proba(x, libsvm_params, @model)
       end

data/lib/rumale/svm/svc.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/classifier'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -12,9 +13,8 @@ module Rumale
     #   estimator = Rumale::SVM::SVC.new(reg_param: 1.0, kernel: 'rbf', gamma: 10.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_labels)
     #   results = estimator.predict(testing_samples)
-    class SVC
-      include Base::BaseEstimator
-      include Base::Classifier
+    class SVC < Rumale::Base::Estimator
+      include Rumale::Base::Classifier
       # Create a new classifier with Kernel C-Support Vector Classifier.
       #
@@ -31,10 +31,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(reg_param: 1.0, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
                      shrinking: true, probability: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_numeric(reg_param: reg_param, degree: degree, gamma: gamma, coef0: coef0, cache_size: cache_size, tol: tol)
-        check_params_string(kernel: kernel)
-        check_params_boolean(shrinking: shrinking, probability: probability, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:reg_param] = reg_param.to_f
         @params[:kernel] = kernel
@@ -56,9 +53,9 @@ module Rumale
       # @param y [Numo::Int32] (shape: [n_samples]) The labels to be used for fitting the model.
       # @return [SVC] The learned classifier itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_label_array(y)
-        check_sample_label_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_label_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = precomputed_kernel? ? add_index_col(x) : x
         @model = Numo::Libsvm.train(xx, y, libsvm_params)
         self
@@ -70,8 +67,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.decision_function(xx, libsvm_params, @model)
       end
@@ -82,8 +79,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Int32.cast(Numo::Libsvm.predict(xx, libsvm_params, @model))
       end
@@ -95,8 +92,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict_proba(xx, libsvm_params, @model)
       end

data/lib/rumale/svm/svr.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 require 'numo/libsvm'
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/regressor'
+require 'rumale/validation'
 module Rumale
   module SVM
@@ -12,9 +13,8 @@ module Rumale
     #   estimator = Rumale::SVM::SVR.new(reg_param: 1.0, kernel: 'rbf', gamma: 10.0, random_seed: 1)
     #   estimator.fit(training_samples, traininig_target_values)
     #   results = estimator.predict(testing_samples)
-    class SVR
-      include Base::BaseEstimator
-      include Base::Regressor
+    class SVR < Rumale::Base::Estimator
+      include Rumale::Base::Regressor
       # Create a new regressor with Kernel Epsilon-Support Vector Regressor.
       #
@@ -31,11 +31,7 @@ module Rumale
       # @param random_seed [Integer/Nil] The seed value using to initialize the random generator.
       def initialize(reg_param: 1.0, epsilon: 0.1, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
                      shrinking: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
-        check_params_numeric(reg_param: reg_param, degree: degree, epsilon: epsilon, gamma: gamma, coef0: coef0,
-                             cache_size: cache_size, tol: tol)
-        check_params_string(kernel: kernel)
-        check_params_boolean(shrinking: shrinking, verbose: verbose)
-        check_params_numeric_or_nil(random_seed: random_seed)
+        super()
         @params = {}
         @params[:reg_param] = reg_param.to_f
         @params[:epsilon] = epsilon.to_f
@@ -57,9 +53,9 @@ module Rumale
       # @param y [Numo::DFloat] (shape: [n_samples]) The target values to be used for fitting the model.
       # @return [SVR] The learned regressor itself.
       def fit(x, y)
-        x = check_convert_sample_array(x)
-        y = check_convert_tvalue_array(y)
-        check_sample_tvalue_size(x, y)
+        x = Rumale::Validation.check_convert_sample_array(x)
+        y = Rumale::Validation.check_convert_target_value_array(y)
+        Rumale::Validation.check_sample_size(x, y)
         xx = precomputed_kernel? ? add_index_col(x) : x
         @model = Numo::Libsvm.train(xx, y, libsvm_params)
         self
@@ -71,8 +67,8 @@ 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)
+        raise "#{self.class.name}##{__method__} expects to be called after training the model with the fit method." unless trained?
+        x = Rumale::Validation.check_convert_sample_array(x)
         xx = precomputed_kernel? ? add_index_col(x) : x
         Numo::Libsvm.predict(xx, libsvm_params, @model)
       end

data/lib/rumale/svm/version.rb CHANGED Viewed

@@ -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.7.0'
+    VERSION = '0.8.0'
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumale-svm
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-liblinear
@@ -39,13 +39,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rumale
+  name: rumale-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '0.24'
   type: :runtime
@@ -53,9 +50,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '0.24'
 description: 'Rumale::SVM provides support vector machine algorithms of LIBSVM and
@@ -116,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Rumale::SVM provides support vector machine algorithms of LIBSVM and LIBLINEAR