rumale-svm 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0000e7a25f4aaf36f645a7860d13bed3ca06ea7d99bc15469cd7c9ea0a57288
-  data.tar.gz: 0db6f53cabe1a84493d20bf9e0822057dca4ec92042bdefb6fda15f794aba9aa
+  metadata.gz: ec0ef314d44123fa222655004b099652d244c7fb9bea73569a4fe701974e43b1
+  data.tar.gz: ccaca04e1b3fe7691467a26a678f8978bc2f77e5a1b2e094b1af08923779588b
 SHA512:
-  metadata.gz: af0433aacb57daa0b9bf81dfe961f71ef71751215749201c18c1c81aa592d55050e4ed6d65605809ff6c36153cbbeb45e200181675dec23e13f884b70185ccab
-  data.tar.gz: c97c4a38ccdfabd869e6f5196eae73f32371d7bd12ff8e9612ede2cbfe89bb3bc563505429590ef65d928ba84d76cc06cf9c5f9eee0e79b161cbfd470da80cc0
+  metadata.gz: 44b1ab01d131133ef5d9fb32ae4dfaff5ca1187e45c5a1b4f4ec3b198f515020baf85b5bb4a1bb110ae6e85d74f521af86661b4741a63828bd49288a138c9513
+  data.tar.gz: af83ab927ed5fbd630880b51fa2a0bf25c9aaad066a603d1ce6bf178c873ed669461eb46cdb23003b888799f11a5114fdf5405288d8129783c9495ec74799fd5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.7.0
+- Support for probabilistic outputs with Rumale::SVM::OneClassSVM.
+- Update numo-libsvm depedency to v2.1 or higher.
+
+# 0.6.0
+- Update numo-libsvm and numo-liblinear depedency to v2.0 or higher.
+
 # 0.5.1
 - Refator specs and config files.
 

data/lib/rumale/svm/one_class_svm.rb

@@ -24,15 +24,16 @@ module Rumale
       # @param gamma [Float] The gamma parameter in rbf/poly/sigmoid kernel function.
       # @param coef0 [Float] The coefficient in poly/sigmoid kernel function.
       # @param shrinking [Boolean] The flag indicating whether to use the shrinking heuristics.
+      # @param probability [Boolean] The flag indicating whether to train the parameter for probability estimation.
       # @param cache_size [Float] The cache memory size in MB.
       # @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: 1.0, kernel: 'rbf', degree: 3, gamma: 1.0, coef0: 0.0,
-                     shrinking: true, cache_size: 200.0, tol: 1e-3, verbose: false, random_seed: nil)
+                     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, verbose: verbose)
+        check_params_boolean(shrinking: shrinking, probability: probability, verbose: verbose)
         check_params_numeric_or_nil(random_seed: random_seed)
         @params = {}
         @params[:nu] = nu.to_f
@@ -41,6 +42,7 @@ module Rumale
         @params[:gamma] = gamma.to_f
         @params[:coef0] = coef0.to_f
         @params[:shrinking] = shrinking
+        @params[:probability] = probability
         @params[:cache_size] = cache_size.to_f
         @params[:tol] = tol.to_f
         @params[:verbose] = verbose
@@ -82,6 +84,19 @@ module Rumale
         Numo::Int32.cast(Numo::Libsvm.predict(x, libsvm_params, @model))
       end
 
+      # Predict class probability for samples.
+      # This method works correctly only if the probability parameter is true.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the probailities.
+      #   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)
+        Numo::Libsvm.predict_proba(x, libsvm_params, @model)
+      end
+
       # Dump marshal data.
       # @return [Hash] The marshal data about SVC.
       def marshal_dump
@@ -150,6 +165,10 @@ module Rumale
       def trained?
         !@model.nil?
       end
+
+      def trained_probs?
+        @model[:prob_density_marks].is_a?(Numo::NArray)
+      end
     end
   end
 end

data/lib/rumale/svm/version.rb

@@ -4,7 +4,7 @@
 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.5.1'
+    # The version of Rumale::SVM you are using.
+    VERSION = '0.7.0'
   end
 end

data/sig/rumale/svm/one_class_svm.rbs

@@ -10,6 +10,7 @@ module Rumale
       def fit: (Numo::DFloat x, ?untyped? _y) -> OneClassSVM
       def decision_function: (Numo::DFloat x) -> Numo::DFloat
       def predict: (Numo::DFloat x) -> Numo::Int32
+      def predict_proba: (Numo::DFloat x) -> Numo::DFloat
       def marshal_dump: () -> { params: Hash[Symbol, untyped], model: untyped }
       def marshal_load: (Hash[Symbol, untyped] obj) -> void
       def support: () -> Numo::Int32

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumale-svm
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-liblinear
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: numo-libsvm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rumale
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.24'
-description: 'Rumale-SVM provides support vector machine algorithms of LIBSVM and
+description: 'Rumale::SVM provides support vector machine algorithms of LIBSVM and
   LIBLINEAR with Rumale interface.
 
   '
@@ -116,9 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Rumale-SVM provides support vector machine algorithms of LIBSVM and LIBLINEAR
+summary: Rumale::SVM provides support vector machine algorithms of LIBSVM and LIBLINEAR
   with Rumale interface.
 test_files: []