numo-libsvm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8cf97ac572136b9ee1d0919dc308eded11bc3ce
-  data.tar.gz: 6df5e37fa325cf802643626c95f88498b75f50a8
+  metadata.gz: '098e529149ba06f54fc8c4949afa2051dd62f856'
+  data.tar.gz: b86c22820135dff7f95c34dfe6517f89d451156f
 SHA512:
-  metadata.gz: ac703a48952bfcf3909c672f6901c8873e4c5e1f2c998da28d3912bc62d254f4cb2e689417c8472fb9e10a9f80c6a9f4cfda4b64850de1cbb4ca1d34527277da
-  data.tar.gz: 826f1d341a53c733dfc0917615829b66673d18e43cd4efce062634057b84201347a1398da2dbb6b80b8baaebfbea784b8c10d57f2b0e7da73e9ac6e9389d2917
+  metadata.gz: 8d3ed02591f622d50203c6552671ebcfa26ead1cf86816e0ae166548981409ef8b6b14bce2a0123e9d3f1abcaf121b52c49e7ee4110ebc3e4a0f4224902c388a
+  data.tar.gz: 56595713d0dccca3f953ee7583f90ca6fb63d83eedb0d6f2878caaacf6c8db859628f82c88e95b5062eabb85316bbe034fa716b86aebd07fc5f414a5f1ccda77

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.4.0
+- Add verbose parameter to output learning process messages.
+- Several documentation improvements.
+
 # 0.3.0
 - Add random_seed parameter for specifying seed to give to srand function.
 - Several documentation improvements.

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.3.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-libsvm/0.4.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,
@@ -190,6 +190,7 @@ param = {
   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
+  verbose: false,                   # [Boolean] Whether to output learning process message
   random_seed: 1                    # [Integer/Nil] Random seed
 }
 ```

data/ext/numo/libsvm/libsvmext.c

@@ -55,6 +55,7 @@ VALUE train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash)
   narray_t* y_nary;
   char* err_msg;
   VALUE random_seed;
+  VALUE verbose;
   VALUE model_hash;
 
   if (CLASS_OF(x_val) != numo_cDFloat) {
@@ -101,7 +102,11 @@ VALUE train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash)
     return Qnil;
   }
 
-  svm_set_print_string_function(print_null);
+  verbose = rb_hash_aref(param_hash, ID2SYM(rb_intern("verbose")));
+  if (verbose != Qtrue) {
+    svm_set_print_string_function(print_null);
+  }
+
   model = svm_train(problem, param);
   model_hash = svm_model_to_rb_hash(model);
   svm_free_and_destroy_model(&model);
@@ -122,6 +127,30 @@ VALUE train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash)
  *   @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.
@@ -138,6 +167,7 @@ VALUE cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash, V
   narray_t* y_nary;
   char* err_msg;
   VALUE random_seed;
+  VALUE verbose;
   struct svm_problem* problem;
   struct svm_parameter* param;
 
@@ -189,7 +219,11 @@ VALUE cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALUE param_hash, V
   t_val = rb_narray_new(numo_cDFloat, 1, t_shape);
   t_pt = (double*)na_get_pointer_for_write(t_val);
 
-  svm_set_print_string_function(print_null);
+  verbose = rb_hash_aref(param_hash, ID2SYM(rb_intern("verbose")));
+  if (verbose != Qtrue) {
+    svm_set_print_string_function(print_null);
+  }
+
   svm_cross_validation(problem, param, n_folds, t_pt);
 
   xfree_svm_problem(problem);

data/lib/numo/libsvm/version.rb

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

metadata

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