numo-libsvm 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72a8a48f52a71000c0ff4b1202684a8929a8e34b3004f5f142cccbd9af1e034
-  data.tar.gz: 7c8f38da980376b9ca84191235e10cf98bd9ff44ab546ee3b52d105b57cb4ec7
+  metadata.gz: 1c35f46a2bba049bfb540087ab92b16213aef0289088b0d07c656054bf62be75
+  data.tar.gz: c8473b0084bdb2e2a7396d906f5264bf9e0dc315f43aac1c5feae90d52e7a0e4
 SHA512:
-  metadata.gz: 795830bf885ba8164bb95619eb713cd3b893c61c0c3b1f43de66afb7d3632383054e1ca6870d48ca8a69f0b1fc2007e42b5e37ab67ef14848dd7a471c4d195d2
-  data.tar.gz: 41388d1b428d3e4e7a181149cc53a7b1654af3b61961dce67948b86ef54fb96eb24e626d1ffe2645fc59886e37d44ec3ba20333c2e17cab5446513d65f205e8c
+  metadata.gz: e164fae3d226b73f226fda35b5997b92752dc2386d2be8d9a4cfa00e8f0ca42eb7ed96f597f72ffd2f2203aef7ced2a0bc60b0c82fbc39c1089b3510d2275d49
+  data.tar.gz: be27aa1d940590808e9e6235e2a5fc00e9e5ec32715effea22218fa92bb85d922610db332c8a9d9dff6aa6ae9233e1d39bb6f7f28e0270a2057c8b6a5aef912e

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 2.0.0
+- Redesign native extension codes.
+- Change not ot use git submodule for LIBSVM codes bundle.
+- Introduce conventional commits.
+
+# 1.1.2
+- Remove dependent gem's type declaration file from installation files.
+
+# 1.1.1
+- Fix version specifier of runtime dependencies.
+
+# 1.1.0
+- Add type declaration file: sig/numo/libsvm.rbs
+
 # 1.0.2
 - Add GC guard to model saving and loading methods.
 - Fix size specification to memcpy function.

data/LICENSE.txt

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

data/README.md

@@ -158,7 +158,7 @@ Accuracy: 98.3 %
 ### Note
 The hyperparameter of SVM is given with Ruby Hash on Numo::Libsvm.
 The hash key of hyperparameter and its meaning match the struct svm_parameter of LIBSVM.
-The svm_parameter is detailed in [LIBSVM README](https://github.com/cjlin1/libsvm/blob/main/README).
+The svm_parameter is detailed in [LIBSVM README](https://github.com/cjlin1/libsvm/blob/master/README).
 
 ```ruby
 param = {
@@ -194,7 +194,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yoshok
 ## License
 
 The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
-
-## Code of Conduct
-
-Everyone interacting in the Numo::Libsvm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-libsvm/blob/main/CODE_OF_CONDUCT.md).

data/ext/numo/libsvm/extconf.rb

@@ -8,10 +8,7 @@ $LOAD_PATH.each do |lp|
   end
 end
 
-unless have_header('numo/narray.h')
-  puts 'numo/narray.h not found.'
-  exit(1)
-end
+abort 'numo/narray.h not found.' unless have_header('numo/narray.h')
 
 if RUBY_PLATFORM =~ /mswin|cygwin|mingw/
   $LOAD_PATH.each do |lp|
@@ -20,20 +17,13 @@ if RUBY_PLATFORM =~ /mswin|cygwin|mingw/
       break
     end
   end
-  unless have_library('narray', 'nary_new')
-    puts 'libnarray.a not found.'
-    exit(1)
-  end
+  abort 'libnarray.a not found.' unless have_library('narray', 'nary_new')
 end
 
-$LDFLAGS << ' -lstdc++ '
+abort 'libstdc++ is not found.' unless have_library('stdc++')
 
-$srcs = Dir.glob("#{$srcdir}/*.c").map { |path| File.basename(path) }
-$srcs << 'svm.cpp'
-Dir.glob("#{$srcdir}/*/") do |path|
-  dir = File.basename(path)
-  $INCFLAGS << " -I$(srcdir)/#{dir}"
-  $VPATH << "$(srcdir)/#{dir}"
-end
+$srcs = Dir.glob("#{$srcdir}/**/*.cpp").map { |path| File.basename(path) }
+$INCFLAGS << " -I$(srcdir)/src"
+$VPATH << "$(srcdir)/src"
 
 create_makefile('numo/libsvm/libsvmext')

data/ext/numo/libsvm/libsvmext.cpp

@@ -0,0 +1,220 @@
+/**
+ * Copyright (c) 2019-2022 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.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+#include "libsvmext.hpp"
+
+extern "C" void Init_libsvmext(void) {
+  rb_require("numo/narray");
+
+  /**
+   * Document-module: Numo
+   * Numo is the top level namespace of NUmerical MOdules for Ruby.
+   */
+
+  /**
+   * Document-module: Numo::Libsvm
+   * Numo::Libsvm is a binding library for LIBSVM that handles dataset with Numo::NArray.
+   */
+  VALUE mLibsvm = rb_define_module_under(mNumo, "Libsvm");
+
+  /* The version of LIBSVM used in backgroud library. */
+  rb_define_const(mLibsvm, "LIBSVM_VERSION", INT2NUM(LIBSVM_VERSION));
+
+  /**
+   * Document-module: Numo::Libsvm::SvmType
+   * The module consisting of constants for SVM algorithm type that used for parameter of LIBSVM.
+   */
+  VALUE mSvmType = rb_define_module_under(mLibsvm, "SvmType");
+  /* C-SVM classification */
+  rb_define_const(mSvmType, "C_SVC", INT2NUM(C_SVC));
+  /* nu-SVM classification */
+  rb_define_const(mSvmType, "NU_SVC", INT2NUM(NU_SVC));
+  /* one-class-SVM */
+  rb_define_const(mSvmType, "ONE_CLASS", INT2NUM(ONE_CLASS));
+  /* epsilon-SVM regression */
+  rb_define_const(mSvmType, "EPSILON_SVR", INT2NUM(EPSILON_SVR));
+  /* nu-SVM regression */
+  rb_define_const(mSvmType, "NU_SVR", INT2NUM(NU_SVR));
+
+  /**
+   * Document-module: Numo::Libsvm::KernelType
+   * The module consisting of constants for kernel type that used for parameter of LIBSVM.
+   */
+  VALUE mKernelType = rb_define_module_under(mLibsvm, "KernelType");
+  /* Linear kernel; u' * v */
+  rb_define_const(mKernelType, "LINEAR", INT2NUM(LINEAR));
+  /* Polynomial kernel; (gamma * u' * v + coef0)^degree */
+  rb_define_const(mKernelType, "POLY", INT2NUM(POLY));
+  /* RBF kernel; exp(-gamma * ||u - v||^2) */
+  rb_define_const(mKernelType, "RBF", INT2NUM(RBF));
+  /* Sigmoid kernel; tanh(gamma * u' * v + coef0) */
+  rb_define_const(mKernelType, "SIGMOID", INT2NUM(SIGMOID));
+  /* Precomputed kernel */
+  rb_define_const(mKernelType, "PRECOMPUTED", INT2NUM(PRECOMPUTED));
+
+  /**
+   * Train the SVM model according to the given training data.
+   *
+   * @overload train(x, y, param) -> Hash
+   *   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to be used for training the model.
+   *   @param y [Numo::DFloat] (shape: [n_samples]) The labels or target values for samples.
+   *   @param param [Hash] The parameters of an SVM model.
+   *
+   * @example
+   *   require 'numo/libsvm'
+   *
+   *   # Prepare XOR data.
+   *   x = Numo::DFloat[[-0.8, -0.7], [0.9, 0.8], [-0.7, 0.9], [0.8, -0.9]]
+   *   y = Numo::Int32[-1, -1, 1, 1]
+   *
+   *   # Train C-Support Vector Classifier with RBF kernel.
+   *   param = {
+   *     svm_type: Numo::Libsvm::SvmType::C_SVC,
+   *     kernel_type: Numo::Libsvm::KernelType::RBF,
+   *     gamma: 2.0,
+   *     C: 1,
+   *     random_seed: 1
+   *   }
+   *   model = Numo::Libsvm.train(x, y, param)
+   *
+   *   # Predict labels of test data.
+   *   x_test = Numo::DFloat[[-0.4, -0.5], [0.5, -0.4]]
+   *   result = Numo::Libsvm.predict(x_test, param, model)
+   *   p result
+   *   # Numo::DFloat#shape=[2]
+   *   # [-1, 1]
+   *
+   * @raise [ArgumentError] If the sample array is not 2-dimensional, the label array is not 1-dimensional,
+   *   the sample array and label array do not have the same number of samples, or
+   *   the hyperparameter has an invalid value, this error is raised.
+   * @return [Hash] The model obtained from the training procedure.
+   */
+  rb_define_module_function(mLibsvm, "train", RUBY_METHOD_FUNC(numo_libsvm_train), 3);
+  /**
+   * Perform cross validation under given parameters. The given samples are separated to n_fols folds.
+   * The predicted labels or values in the validation process are returned.
+   *
+   * @overload cv(x, y, param, n_folds) -> Numo::DFloat
+   *   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to be used for training the model.
+   *   @param y [Numo::DFloat] (shape: [n_samples]) The labels or target values for samples.
+   *   @param param [Hash] The parameters of an SVM model.
+   *   @param n_folds [Integer] The number of folds.
+   *
+   * @example
+   *   require 'numo/libsvm'
+   *
+   *   # x: samples
+   *   # y: labels
+   *
+   *   # Define parameters of C-SVC with RBF Kernel.
+   *   param = {
+   *     svm_type: Numo::Libsvm::SvmType::C_SVC,
+   *     kernel_type: Numo::Libsvm::KernelType::RBF,
+   *     gamma: 1.0,
+   *     C: 1,
+   *     random_seed: 1,
+   *     verbose: true
+   *   }
+   *
+   *   # Perform 5-cross validation.
+   *   n_folds = 5
+   *   res = Numo::Libsvm.cv(x, y, param, n_folds)
+   *
+   *   # Print mean accuracy.
+   *   mean_accuracy = y.eq(res).count.fdiv(y.size)
+   *   puts "Accuracy: %.1f %%" % (100 * mean_accuracy)
+   *
+   * @raise [ArgumentError] If the sample array is not 2-dimensional, the label array is not 1-dimensional,
+   *   the sample array and label array do not have the same number of samples, or
+   *   the hyperparameter has an invalid value, this error is raised.
+   * @return [Numo::DFloat] (shape: [n_samples]) The predicted class label or value of each sample.
+   */
+  rb_define_module_function(mLibsvm, "cv", RUBY_METHOD_FUNC(numo_libsvm_cross_validation), 4);
+  /**
+   * Predict class labels or values for given samples.
+   *
+   * @overload predict(x, param, model) -> Numo::DFloat
+   *   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to calculate the scores.
+   *   @param param [Hash] The parameters of the trained SVM model.
+   *   @param model [Hash] The model obtained from the training procedure.
+   *
+   * @raise [ArgumentError] If the sample array is not 2-dimensional, this error is raised.
+   * @return [Numo::DFloat] (shape: [n_samples]) The predicted class label or value of each sample.
+   */
+  rb_define_module_function(mLibsvm, "predict", RUBY_METHOD_FUNC(numo_libsvm_predict), 3);
+  /**
+   * Calculate decision values for given samples.
+   *
+   * @overload decision_function(x, param, model) -> Numo::DFloat
+   *   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to calculate the scores.
+   *   @param param [Hash] The parameters of the trained SVM model.
+   *   @param model [Hash] The model obtained from the training procedure.
+   *
+   * @raise [ArgumentError] If the sample array is not 2-dimensional, this error is raised.
+   * @return [Numo::DFloat] (shape: [n_samples, n_classes * (n_classes - 1) / 2]) The decision value of each sample.
+   */
+  rb_define_module_function(mLibsvm, "decision_function", RUBY_METHOD_FUNC(numo_libsvm_decision_function), 3);
+  /**
+   * Predict class probability for given samples. The model must have probability information calcualted in training procedure.
+   * The parameter ':probability' set to 1 in training procedure.
+   *
+   * @overload predict_proba(x, param, model) -> Numo::DFloat
+   *   @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the class probabilities.
+   *   @param param [Hash] The parameters of the trained SVM model.
+   *   @param model [Hash] The model obtained from the training procedure.
+   *
+   * @raise [ArgumentError] If the sample array is not 2-dimensional, this error is raised.
+   * @return [Numo::DFloat] (shape: [n_samples, n_classes]) Predicted probablity of each class per sample.
+   */
+  rb_define_module_function(mLibsvm, "predict_proba", RUBY_METHOD_FUNC(numo_libsvm_predict_proba), 3);
+  /**
+   * Load the SVM parameters and model from a text file with LIBSVM format.
+   *
+   * @overload load_svm_model(filename) -> Array
+   *   @param filename [String] The path to a file to load.
+   *
+   * @raise [IOError] This error raises when failed to load the model file.
+   * @return [Array] Array contains the SVM parameters and model.
+   */
+  rb_define_module_function(mLibsvm, "load_svm_model", RUBY_METHOD_FUNC(numo_libsvm_load_model), 1);
+  /**
+   * Save the SVM parameters and model as a text file with LIBSVM format. The saved file can be used with the libsvm tools.
+   * Note that the svm_save_model saves only the parameters necessary for estimation with the trained model.
+   *
+   * @overload save_svm_model(filename, param, model) -> Boolean
+   *   @param filename [String] The path to a file to save.
+   *   @param param [Hash] The parameters of the trained SVM model.
+   *   @param model [Hash] The model obtained from the training procedure.
+   *
+   * @raise [IOError] This error raises when failed to save the model file.
+   * @return [Boolean] true on success, or false if an error occurs.
+   */
+  rb_define_module_function(mLibsvm, "save_svm_model", RUBY_METHOD_FUNC(numo_libsvm_save_model), 3);
+}