numo-liblinear 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bf71a14ccac359b6dffce32a5a5d3c784ef9efa
-  data.tar.gz: 6af9f95c6b28c11b06fc0b10628a37e9397564c5
+  metadata.gz: 0ae7bd5566c47d6b045d596945bf7b4b84955b22
+  data.tar.gz: 13dc445acfcf11c6097dedbbf25544f19810cb60
 SHA512:
-  metadata.gz: 18e64c5d487cab2636216425e45fd8eeaefa0f14026068d3678f0d8d643aea00acf867aa64ba510a62d4c343408a9e22bace2a0347a7b7aba7ddd872f2bbc579
-  data.tar.gz: 43e16f69a931aab7a45163f1909e307f3334ef88f4e45ed79e5513b288804d5c0dfcbb92ef79642bb7c40e70bcdffe6f47548a2cad10351da3585dd48f0a84db
+  metadata.gz: 4dac8c681d092896a0d1947ed3374d4400ea224c3bc18c4fd2ebfa65aa504181e7c01f3ffb68452d92bb22bbe54fc61e831b9bc7197da26cf3908df8b59d9fc3
+  data.tar.gz: 9b2a82a5a087a1f86113c10be3a11880b03357bb9e3b91191291f2824e26c672c542a7401a69638aefc3ef36a7bcee51bbdfcebad010f0f50c66460aa5e99fac

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-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.2.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/numo-liblinear/0.3.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.
@@ -153,6 +153,27 @@ Predict labels.
 Accuracy: 87.9 %
 ```
 
+## Note
+The hyperparemter of LIBLINEAR is given with Ruby Hash on Numo::Liblinear.
+The hash key of hyperparameter and its meaning match the struct parameter of LIBLINEAR.
+The parameter is detailed in [LIBLINEAR README](https://github.com/cjlin1/liblinear/blob/master/README)
+
+```ruby
+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.
+    Numo::Int32[0, 1, 2],
+  weight:                         # [Numo::DFloat] Weight values.
+    Numo::DFloat[0.4, 0.4, 0.2],
+  p: 0.1,                         # [Float] Sensitiveness of loss of support vector regression.
+  random_seed: 1                  # [Integer/Nil] Random seed
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/ext/numo/liblinear/liblinearext.c

@@ -16,6 +16,28 @@ 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 a model.
  *
+ * @example
+ *   require 'numo/liblinear'
+ *
+ *   # Prepare training dataset.
+ *   x = Numo::DFloat[[-0.8, 1.0], [-0.5, 0.8], [0.9, -0.8], [0.8, -0.7]]
+ *   y = Numo::Int32[-1, -1, 1, 1]
+ *
+ *   # Train L2-regularized L2-loss support vector classifier.
+ *   param = {
+ *     solver_type: Numo::Liblinear::SolverType::L2R_L2LOSS_SVC_DUAL,
+ *     C: 0.1,
+ *     random_seed: 1
+ *   }
+ *   model = Numo::Liblinear.train(x, y, param)
+ *
+ *   # Predict labels of test data.
+ *   x_test = Numo::DFloat[[-0.7, 0.9], [0.5, -0.4]]
+ *   result = Numo::Liblinear.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 +52,7 @@ VALUE numo_liblinear_train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_has
   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 +83,11 @@ VALUE numo_liblinear_train(VALUE self, VALUE x_val, VALUE y_val, VALUE param_has
     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_parameter(param_hash);
   problem = dataset_to_problem(x_val, y_val);
 
@@ -107,6 +135,7 @@ VALUE numo_liblinear_cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALU
   narray_t* x_nary;
   narray_t* y_nary;
   char* err_msg;
+  VALUE random_seed;
   struct problem* problem;
   struct parameter* param;
 
@@ -138,6 +167,11 @@ VALUE numo_liblinear_cross_validation(VALUE self, VALUE x_val, VALUE y_val, VALU
     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_parameter(param_hash);
   problem = dataset_to_problem(x_val, y_val);
 

data/lib/numo/liblinear/version.rb

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

metadata

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