numo-libsvm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92066a1f30fa986bae110cffad133765bc1a2356
-  data.tar.gz: db27417bc129d089716a97df86b88c3dbd935ac1
+  metadata.gz: c8cf97ac572136b9ee1d0919dc308eded11bc3ce
+  data.tar.gz: 6df5e37fa325cf802643626c95f88498b75f50a8
 SHA512:
-  metadata.gz: 77064dc4a7128b69ca9130165378dd53a71d98ce8fc1cdccc1462a913d1a5f79ebb1394750cdb67122bf3e37ddfd986ade99c39cde299aef492da11b1d58f548
-  data.tar.gz: b37b562c48d434c21b94fff3d1718703011d69be188ed078936936d84fca3d0164cefafad1c880f25191eb72fccd2207824f3e434552b88dc51f736bea8090bb
+  metadata.gz: ac703a48952bfcf3909c672f6901c8873e4c5e1f2c998da28d3912bc62d254f4cb2e689417c8472fb9e10a9f80c6a9f4cfda4b64850de1cbb4ca1d34527277da
+  data.tar.gz: 826f1d341a53c733dfc0917615829b66673d18e43cd4efce062634057b84201347a1398da2dbb6b80b8baaebfbea784b8c10d57f2b0e7da73e9ac6e9389d2917

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+# 0.3.0
+- Add random_seed parameter for specifying seed to give to srand function.
+- Several documentation improvements.
+
 # 0.2.0
-- Add valation of method parameters.
+- Add validation of method parameters.
 - Several documentation improvements.
 
 # 0.1.0

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/yoshoku/numo-libsvm.svg?branch=master)](https://travis-ci.org/yoshoku/numo-libsvm)
 [![Gem Version](https://badge.fury.io/rb/numo-libsvm.svg)](https://badge.fury.io/rb/numo-libsvm)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-libsvm/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-libsvm/0.2.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-libsvm/0.3.0)
 
 Numo::Libsvm is a Ruby gem binding to the [LIBSVM](https://github.com/cjlin1/libsvm) library.
 LIBSVM is one of the famous libraries that implemented Support Vector Machines,
@@ -172,7 +172,6 @@ The svm_parameter is detailed in [LIBSVM README](https://github.com/cjlin1/libsv
 param = {
   svm_type:                         # [Integer] Type of SVM
     Numo::Libsvm::SvmType::C_SVC,
-  # for kernel function
   kernel_type:                      # [Integer] Type of kernel function
     Numo::Libsvm::KernelType::RBF,
   degree: 3,                        # [Integer] Degree in polynomial kernel function
@@ -190,7 +189,8 @@ param = {
   nu: 0.5,                          # [Float] Parameter nu of nu-SVC, one-class SVM, and nu-SVR
   p: 0.1,                           # [Float] Parameter epsilon in loss function of epsilon-SVR
   shrinking: true,                  # [Boolean] Whether to use the shrinking heuristics
-  probability: false                # [Boolean] Whether to train a SVC or SVR model for probability estimates
+  probability: false,               # [Boolean] Whether to train a SVC or SVR model for probability estimates
+  random_seed: 1                    # [Integer/Nil] Random seed
 }
 ```
 

data/ext/numo/libsvm/libsvmext.c

@@ -16,6 +16,30 @@ void print_null(const char *s) {}
  *   @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.
@@ -30,6 +54,7 @@ VALUE train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash)
   narray_t* x_nary;
   narray_t* y_nary;
   char* err_msg;
+  VALUE random_seed;
   VALUE model_hash;
 
   if (CLASS_OF(x_val) != numo_cDFloat) {
@@ -60,6 +85,11 @@ VALUE train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash)
     return Qnil;
   }
 
+  random_seed = rb_hash_aref(param_hash, ID2SYM(rb_intern("random_seed")));
+  if (!NIL_P(random_seed)) {
+    srand(NUM2UINT(random_seed));
+  }
+
   param = rb_hash_to_svm_parameter(param_hash);
   problem = dataset_to_svm_problem(x_val, y_val);
 
@@ -107,6 +137,7 @@ VALUE cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash, V
   narray_t* x_nary;
   narray_t* y_nary;
   char* err_msg;
+  VALUE random_seed;
   struct svm_problem* problem;
   struct svm_parameter* param;
 
@@ -138,6 +169,11 @@ VALUE cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash, V
     return Qnil;
   }
 
+  random_seed = rb_hash_aref(param_hash, ID2SYM(rb_intern("random_seed")));
+  if (!NIL_P(random_seed)) {
+    srand(NUM2UINT(random_seed));
+  }
+
   param = rb_hash_to_svm_parameter(param_hash);
   problem = dataset_to_svm_problem(x_val, y_val);
 

data/lib/numo/libsvm/version.rb

@@ -3,6 +3,6 @@
 module Numo
   module Libsvm
     # The version of Numo::Libsvm you are using.
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-libsvm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray