numo-liblinear 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ae7bd5566c47d6b045d596945bf7b4b84955b22
-  data.tar.gz: 13dc445acfcf11c6097dedbbf25544f19810cb60
+  metadata.gz: 31b76e6a2a8dcfc5cb643fa0b62cd9ace5b6a76c
+  data.tar.gz: 6d8b6d9ed6a7e069ca8fcb78fb9f8999ccdfe1c5
 SHA512:
-  metadata.gz: 4dac8c681d092896a0d1947ed3374d4400ea224c3bc18c4fd2ebfa65aa504181e7c01f3ffb68452d92bb22bbe54fc61e831b9bc7197da26cf3908df8b59d9fc3
-  data.tar.gz: 9b2a82a5a087a1f86113c10be3a11880b03357bb9e3b91191291f2824e26c672c542a7401a69638aefc3ef36a7bcee51bbdfcebad010f0f50c66460aa5e99fac
+  metadata.gz: 8efe216d52fc7bba1561f46c3a372e842d6bdaf371c9b71b7662e380a17e9c6396e4a67348156522a41785bf2a12f37675dd137f173a0f52b6c48528c9c70cf7
+  data.tar.gz: e23e845ed639ee5e7fff6cbbbe936feed71f3a7e16429c52a27872b019201818649de57576030fb996cd697ff490588a0ec8e8d1e452eb0d441baa4ea00bcf52

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-liblinear.svg?branch=master)](https://travis-ci.org/yoshoku/numo-liblinear)
 [![Gem Version](https://badge.fury.io/rb/numo-liblinear.svg)](https://badge.fury.io/rb/numo-liblinear)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-liblinear/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-liblinear/0.3.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-liblinear/0.4.0)
 
 Numo::Liblinear is a Ruby gem binding to the [LIBLINEAR](https://www.csie.ntu.edu.tw/~cjlin/liblinear/) library.
 LIBLINEAR is one of the famous libraries for large-scale regularized linear classification and regression.
@@ -163,13 +163,14 @@ param = {
   solver_type:                    # [Integer] Type of Solver
     Numo::Liblinear::SolverType::L2R_L2LOSS_SVC_DUAL,
   eps: 0.01,                      # [Float] Stopping criterion
-  C: 1,                           # [Float] Cost of constraints violation.
-  nr_weight: 3,                   # [Integer] Number of weights.
-  weight_label:                   # [Numo::Int32] Labels to add weight.
+  C: 1,                           # [Float] Cost of constraints violation
+  nr_weight: 3,                   # [Integer] Number of weights
+  weight_label:                   # [Numo::Int32] Labels to add weight
     Numo::Int32[0, 1, 2],
-  weight:                         # [Numo::DFloat] Weight values.
+  weight:                         # [Numo::DFloat] Weight values
     Numo::DFloat[0.4, 0.4, 0.2],
-  p: 0.1,                         # [Float] Sensitiveness of loss of support vector regression.
+  p: 0.1,                         # [Float] Sensitiveness of loss of support vector regression
+  verbose: false,                 # [Boolean] Whether to output learning process message
   random_seed: 1                  # [Integer/Nil] Random seed
 }
 ```

data/ext/numo/liblinear/liblinearext.c

@@ -53,6 +53,7 @@ VALUE numo_liblinear_train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_has
   narray_t* y_nary;
   char* err_msg;
   VALUE random_seed;
+  VALUE verbose;
   VALUE model_hash;
 
   if (CLASS_OF(x_val) != numo_cDFloat) {
@@ -99,7 +100,11 @@ VALUE numo_liblinear_train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_has
     return Qnil;
   }
 
-  set_print_string_function(print_null);
+  verbose = rb_hash_aref(param_hash, ID2SYM(rb_intern("verbose")));
+  if (verbose != Qtrue) {
+    set_print_string_function(print_null);
+  }
+
   model = train(problem, param);
   model_hash = model_to_rb_hash(model);
   free_and_destroy_model(&model);
@@ -120,6 +125,28 @@ VALUE numo_liblinear_train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_has
  *   @param param [Hash] The parameters of a model.
  *   @param n_folds [Integer] The number of folds.
  *
+ * @example
+ *   require 'numo/liblinear'
+ *
+ *   # x: samples
+ *   # y: labels
+ *
+ *   # Define parameters of L2-regularized L2-loss support vector classification.
+ *   param = {
+ *     solver_type: Numo::Liblinear::SolverType::L2R_L2LOSS_SVC_DUAL,
+ *     C: 1,
+ *     random_seed: 1,
+ *     verbose: true
+ *   }
+ *
+ *   # Perform 5-cross validation.
+ *   n_folds = 5
+ *   res = Numo::Liblinear::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.
@@ -136,6 +163,7 @@ VALUE numo_liblinear_cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALU
   narray_t* y_nary;
   char* err_msg;
   VALUE random_seed;
+  VALUE verbose;
   struct problem* problem;
   struct parameter* param;
 
@@ -187,7 +215,11 @@ VALUE numo_liblinear_cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALU
   t_val = rb_narray_new(numo_cDFloat, 1, t_shape);
   t_pt = (double*)na_get_pointer_for_write(t_val);
 
-  set_print_string_function(print_null);
+  verbose = rb_hash_aref(param_hash, ID2SYM(rb_intern("verbose")));
+  if (verbose != Qtrue) {
+    set_print_string_function(print_null);
+  }
+
   cross_validation(problem, param, n_folds, t_pt);
 
   xfree_problem(problem);

data/lib/numo/liblinear/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-liblinear
 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