xlearn 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbc492d4f4cb0de9c53cac0820251fc1f747de836348280dfa9d1b7e6475f745
-  data.tar.gz: d5f1fcbbb10b96714c38fd9c0c924c98fb01dccf1872734e1084a31ad855503c
+  metadata.gz: db5aa58044f0c7a4b39541599ac60363e32db0ef0583ea5ab2d200b5d355228d
+  data.tar.gz: 6d43254012b3ccf9a2ff23cceeff218e5260970d900d6b5634f122aa6c9b0127
 SHA512:
-  metadata.gz: '048e5915264ba2749e00a91b4c59a773efcd553cf7c764e56df0107e6dd08edcb7bcb86350181b217d095351ea79f47ba6daa84407069fcd9c445683ecdc22a8'
-  data.tar.gz: 46831787724f8ec1d4063859445a0a9e6aefd2a38b4267032eb11ffcadf145ebbd37ab3babcf56599cf31f3f4143126b1663baf409099926860ce88c591adb75
+  metadata.gz: c539cdce4f80deab0306e45b32ed27a98d5e6e90151b7c8d1af4e06d90ed96c404b86beefd79b0d7018b757c2fcee5bf739fd6632dd0fc5baf12a30c5ac94c3b
+  data.tar.gz: 6b93fea811923b106daf660a0dd876ba1e79fcd525c6f8caca4fc1c83ca835caf60644e4db974a09a6bffc0718dcd0d8a41798745eeee818685ddd58d6bd89b4

data/CHANGELOG.md

@@ -1,3 +1,30 @@
-## 0.1.0
+## 0.1.5 (2020-08-22)
+
+- Added support for Rover
+- Improved error message when not fit
+
+## 0.1.4 (2020-02-11)
+
+- Fixed `Could not find xLearn` error on some Linux platforms
+
+## 0.1.3 (2020-02-09)
+
+- Fixed illegal instruction error on some Linux platforms
+
+## 0.1.2 (2020-01-26)
+
+- Changed to Apache 2.0 license to match xLearn
+- Added shared libraries
+- Don't save `bin` file by default
+
+## 0.1.1 (2019-10-13)
+
+- Added `cv` method
+- Added `partial_fit` method
+- Added `save_txt` method
+- Added `bias_term`, `linear_term`, and `latent_factors` methods
+- Added support for Daru and Numo
+
+## 0.1.0 (2019-10-11)
 
 - First release

data/LICENSE.txt

@@ -1,22 +1,202 @@
-Copyright (c) 2019 Andrew Kane
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.txt

@@ -0,0 +1,14 @@
+Copyright XLearn contributors
+Copyright 2019-2020 Andrew Kane
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -2,17 +2,15 @@
 
 [xLearn](https://github.com/aksnzhy/xlearn) - the high performance machine learning library - for Ruby
 
-:fire: Uses the C API for blazing performance
-
 Supports:
 
 - Linear models
 - Factorization machines
 - Field-aware factorization machines
 
-## Installation
+[![Build Status](https://travis-ci.org/ankane/xlearn.svg?branch=master)](https://travis-ci.org/ankane/xlearn) [![Build status](https://ci.appveyor.com/api/projects/status/r7upg4073w7xct35/branch/master?svg=true)](https://ci.appveyor.com/project/ankane/xlearn/branch/master)
 
-First, [install xLearn](https://xlearn-doc.readthedocs.io/en/latest/install/index.html). On Mac, copy `build/lib/libxlearn_api.dylib` to `/usr/local/lib`.
+## Installation
 
 Add this line to your application’s Gemfile:
 
@@ -22,8 +20,6 @@ gem 'xlearn'
 
 ## Getting Started
 
-This library is modeled after the [Python Scikit-learn API](https://xlearn-doc.readthedocs.io/en/latest/python_api/index.html). Some methods are missing at the moment. PRs welcome!
-
 Prep your data
 
 ```ruby
@@ -58,41 +54,141 @@ Load the model from a file
 model.load_model("model.bin")
 ```
 
+Save a text version of the model
+
+```ruby
+model.save_txt("model.txt")
+```
+
+Pass a validation set
+
+```ruby
+model.fit(x_train, y_train, eval_set: [x_val, y_val])
+```
+
+Train online
+
+```ruby
+model.partial_fit(x_train, y_train)
+```
+
+Get the bias term, linear term, and latent factors
+
+```ruby
+model.bias_term
+model.linear_term
+model.latent_factors # fm and ffm only
+```
+
 ## Parameters
 
-Specify parameters
+Pass parameters - default values below
 
 ```ruby
-model = XLearn::FM.new(k: 20, epoch: 50)
+XLearn::FM.new(
+  task: "binary",      # binary (classification), reg (regression)
+  metric: nil,         # acc, prec, recall, f1, auc, mae, mape, rmse, rmsd
+  lr: 0.2,             # learning rate
+  lambda: 0.00002,     # lambda for l2 regularization
+  k: 4,                # latent factors for fm and ffm
+  alpha: 0.3,          # hyper parameter for ftrl
+  beta: 1.0,           # hyper parameter for ftrl
+  lambda_1: 0.00001,   # hyper parameter for ftrl
+  lambda_2: 0.00002,   # hyper parameter for ftrl
+  epoch: 10,           # number of epochs
+  fold: 3,             # number of folds
+  opt: "adagrad",      # sgd, adagrad, ftrl
+  block_size: 500,     # block size for on-disk training in MB
+  early_stop: true,    # use early stopping
+  stop_window: 2,      # size of stop window for early stopping
+  sign: false,         # convert predition output to 0 and 1
+  sigmoid: false,      # convert predition output using sigmoid
+  seed: 1              # random seed to shuffle data set
+)
 ```
 
-Supports the same parameters as [Python](https://xlearn-doc.readthedocs.io/en/latest/all_api/index.html)
+## Cross-Validation
+
+Cross-validation
 
-## Validation
+```ruby
+model.cv(x, y)
+```
 
-Pass a validation set when fitting
+Specify the number of folds
 
 ```ruby
-model.fit(x_train, y_train, eval_set: [x_val, y_val])
+model.cv(x, y, folds: 5)
+```
+
+## Data
+
+Data can be an array of arrays
+
+```ruby
+[[1, 2, 3], [4, 5, 6]]
+```
+
+Or a Numo array
+
+```ruby
+Numo::NArray.cast([[1, 2, 3], [4, 5, 6]])
+```
+
+Or a Rover data frame
+
+```ruby
+Rover.read_csv("houses.csv")
+```
+
+Or a Daru data frame
+
+```ruby
+Daru::DataFrame.from_csv("houses.csv")
 ```
 
 ## Performance
 
-For performance, you can read data directly from files
+For large datasets, read data directly from files
 
 ```ruby
 model.fit("train.txt", eval_set: "validate.txt")
 model.predict("test.txt")
+model.cv("train.txt")
+```
+
+For linear models and factorization machines, use CSV:
+
+```txt
+label,value_1,value_2,...,value_n
+```
+
+Or the `libsvm` format (better for sparse data):
+
+```txt
+label index_1:value_1 index_2:value_2 ... index_n:value_n
+```
+
+> You can also use commas instead of spaces for separators
+
+For field-aware factorization machines, use the `libffm` format:
+
+```txt
+label field_1:index_1:value_1 field_2:index_2:value_2 ...
 ```
 
-[These formats](https://xlearn-doc.readthedocs.io/en/latest/python_api/index.html#choose-machine-learning-algorithm) are supported
+> You can also use commas instead of spaces for separators
 
 You can also write predictions directly to a file
 
 ```ruby
-model.predict("test.txt", out_file: "predictions.txt")
+model.predict("test.txt", out_path: "predictions.txt")
 ```
 
+## Credits
+
+This library is modeled after xLearn’s [Scikit-learn API](https://xlearn-doc.readthedocs.io/en/latest/python_api/index.html).
+
 ## History
 
 View the [changelog](https://github.com/ankane/xlearn/blob/master/CHANGELOG.md)
@@ -105,3 +201,13 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/xlearn/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/xlearn.git
+cd xlearn
+bundle install
+bundle exec rake vendor:all
+bundle exec rake test
+```

data/lib/xlearn.rb

@@ -21,7 +21,9 @@ module XLearn
   class << self
     attr_accessor :ffi_lib
   end
-  self.ffi_lib = ["xlearn_api"]
+  lib_name = FFI.map_library_name("xlearn_api")
+  vendor_lib = File.expand_path("../vendor/#{lib_name}", __dir__)
+  self.ffi_lib = [vendor_lib]
 
   # friendlier error message
   autoload :FFI, "xlearn/ffi"

data/lib/xlearn/dmatrix.rb

@@ -5,14 +5,33 @@ module XLearn
     def initialize(data, label: nil)
       @handle = ::FFI::MemoryPointer.new(:pointer)
 
-      nrow = data.count
-      ncol = data.first.count
+      if matrix?(data)
+        nrow = data.row_count
+        ncol = data.column_count
+        flat_data = data.to_a.flatten
+      elsif daru?(data)
+        nrow, ncol = data.shape
+        flat_data = data.map_rows(&:to_a).flatten
+      elsif rover?(data)
+        nrow, ncol = data.shape
+        flat_data = data.each_row.map(&:values).flatten
+      elsif narray?(data)
+        nrow, ncol = data.shape
+        # TODO convert to SFloat and pass pointer
+        # for better performance
+        flat_data = data.flatten.to_a
+      else
+        nrow = data.count
+        ncol = data.first.count
+        flat_data = data.flatten
+      end
 
-      c_data = ::FFI::MemoryPointer.new(:float, nrow * ncol)
-      c_data.put_array_of_float(0, data.flatten)
+      c_data = ::FFI::MemoryPointer.new(:float, flat_data.size)
+      c_data.put_array_of_float(0, flat_data)
 
       if label
-        c_label = ::FFI::MemoryPointer.new(:float, nrow)
+        label = label.to_a
+        c_label = ::FFI::MemoryPointer.new(:float, label.size)
         c_label.put_array_of_float(0, label)
       end
 
@@ -31,5 +50,23 @@ module XLearn
       # must use proc instead of stabby lambda
       proc { FFI.XlearnDataFree(pointer) }
     end
+
+    private
+
+    def matrix?(data)
+      defined?(Matrix) && data.is_a?(Matrix)
+    end
+
+    def daru?(data)
+      defined?(Daru::DataFrame) && data.is_a?(Daru::DataFrame)
+    end
+
+    def narray?(data)
+      defined?(Numo::NArray) && data.is_a?(Numo::NArray)
+    end
+
+    def rover?(data)
+      defined?(Rover::DataFrame) && data.is_a?(Rover::DataFrame)
+    end
   end
 end

data/lib/xlearn/ffi.rb

@@ -2,12 +2,7 @@ module XLearn
   module FFI
     extend ::FFI::Library
 
-    begin
-      ffi_lib XLearn.ffi_lib
-    rescue LoadError => e
-      raise e if ENV["XLEARN_DEBUG"]
-      raise LoadError, "Could not find xLearn"
-    end
+    ffi_lib XLearn.ffi_lib
 
     # https://github.com/aksnzhy/xlearn/blob/master/src/c_api/c_api.h
     # keep same order

data/lib/xlearn/ffm.rb

@@ -4,5 +4,24 @@ module XLearn
       @model_type = "ffm"
       super
     end
+
+    # shape is [i, j, k]
+    # for v_{i}_{j}
+    def latent_factors
+      factor = []
+      current = -1
+      read_txt do |line|
+        if line.start_with?("v_")
+          parts = line.split(": ")
+          i = parts.first.split("_")[1].to_i
+          if i != current
+            factor << []
+            current = i
+          end
+          factor.last << parts.last.split(" ").map(&:to_f)
+        end
+      end
+      factor
+    end
   end
 end

data/lib/xlearn/fm.rb

@@ -4,5 +4,17 @@ module XLearn
       @model_type = "fm"
       super
     end
+
+    # shape is [i, k]
+    # for v_{i}
+    def latent_factors
+      factor = []
+      read_txt do |line|
+        if line.start_with?("v_")
+          factor << line.split(": ").last.split(" ").map(&:to_f)
+        end
+      end
+      factor
+    end
   end
 end

data/lib/xlearn/model.rb

@@ -9,7 +9,8 @@ module XLearn
 
       options = {
         task: "binary",
-        quiet: true
+        quiet: true,
+        bin_out: false
       }.merge(options)
 
       if options[:task] == "binary" && !options.key?(:sigmoid)
@@ -20,14 +21,14 @@ module XLearn
     end
 
     def fit(x, y = nil, eval_set: nil)
-      if x.is_a?(String)
-        check_call FFI.XLearnSetTrain(@handle, x)
-        check_call FFI.XLearnSetBool(@handle, "from_file", true)
-      else
-        train_set = DMatrix.new(x, label: y)
-        check_call FFI.XLearnSetDMatrix(@handle, "train", train_set)
-        check_call FFI.XLearnSetBool(@handle, "from_file", false)
-      end
+      @model_path = nil
+      partial_fit(x, y, eval_set: eval_set)
+    end
+
+    def partial_fit(x, y = nil, eval_set: nil)
+      check_call FFI.XLearnSetPreModel(@handle, @model_path || "")
+
+      set_train_set(x, y)
 
       if eval_set
         if eval_set.is_a?(String)
@@ -38,12 +39,17 @@ module XLearn
         end
       end
 
-      # TODO unlink in finalizer
-      @model_file = Tempfile.new("xlearn")
+      @txt_file ||= create_tempfile
+      check_call FFI.XLearnSetTXTModel(@handle, @txt_file.path)
+
+      @model_file ||= create_tempfile
       check_call FFI.XLearnFit(@handle, @model_file.path)
+      @model_path = @model_file.path
     end
 
     def predict(x, out_path: nil)
+      raise Error, "Not trained" unless @model_file
+
       if x.is_a?(String)
         check_call FFI.XLearnSetTest(@handle, x)
         check_call FFI.XLearnSetBool(@handle, "from_file", true)
@@ -63,24 +69,72 @@ module XLearn
       end
     end
 
+    def cv(x, y = nil, folds: nil)
+      set_params(fold: folds) if folds
+      set_train_set(x, y)
+      check_call FFI.XLearnCV(@handle)
+    end
+
     def save_model(path)
       raise Error, "Not trained" unless @model_file
       FileUtils.cp(@model_file.path, path)
     end
 
+    def save_txt(path)
+      raise Error, "Not trained" unless @txt_file
+      FileUtils.cp(@txt_file.path, path)
+    end
+
     def load_model(path)
-      @model_file ||= Tempfile.new("xlearn")
+      @model_file ||= create_tempfile
       # TODO ensure tempfile is still cleaned up
       FileUtils.cp(path, @model_file.path)
     end
 
+    def bias_term
+      read_txt do |line|
+        return line.split(":").last.to_f if line.start_with?("bias:")
+      end
+    end
+
+    def linear_term
+      term = []
+      read_txt do |line|
+        if line.start_with?("i_")
+          term << line.split(":").last.to_f
+        elsif line.start_with?("v_")
+          break
+        end
+      end
+      term
+    end
+
     def self.finalize(pointer)
       # must use proc instead of stabby lambda
       proc { FFI.XLearnHandleFree(pointer) }
     end
 
+    def self.finalize_file(file)
+      # must use proc instead of stabby lambda
+      proc do
+        file.close
+        file.unlink
+      end
+    end
+
     private
 
+    def set_train_set(x, y)
+      if x.is_a?(String)
+        check_call FFI.XLearnSetTrain(@handle, x)
+        check_call FFI.XLearnSetBool(@handle, "from_file", true)
+      else
+        train_set = DMatrix.new(x, label: y)
+        check_call FFI.XLearnSetDMatrix(@handle, "train", train_set)
+        check_call FFI.XLearnSetBool(@handle, "from_file", false)
+      end
+    end
+
     def set_params(params)
       params.each do |k, v|
         k = k.to_s
@@ -100,5 +154,19 @@ module XLearn
         check_call ret
       end
     end
+
+    def read_txt
+      if @txt_file
+        File.foreach(@txt_file.path) do |line|
+          yield line
+        end
+      end
+    end
+
+    def create_tempfile
+      file = Tempfile.new("xlearn")
+      ObjectSpace.define_finalizer(self, self.class.finalize_file(file))
+      file
+    end
   end
 end

data/lib/xlearn/version.rb

@@ -1,3 +1,3 @@
 module XLearn
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/vendor/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/vendor/NOTICE

@@ -0,0 +1,108 @@
+Copyright XLearn contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+Copyright (C) 2011 Paul Mineiro
+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 Paul Mineiro nor the names
+    of other 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 OWNER
+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.
+
+Contact: Paul Mineiro <paul@mineiro.com>
+
+---
+
+Copyright 2011 Martin T. Sandsmark <sandsmark@samfundet.no>
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. 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.
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
+
+---
+
+Protocol Buffers - Google's data interchange format
+
+Copyright 2008 Google Inc.  All rights reserved.
+https://developers.google.com/protocol-buffers/
+
+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 Google Inc. 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
+OWNER 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlearn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: daru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: numo-narray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rover-df
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: andrew@chartkick.com
 executables: []
@@ -74,6 +116,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
+- NOTICE.txt
 - README.md
 - lib/xlearn.rb
 - lib/xlearn/dmatrix.rb
@@ -84,9 +127,14 @@ files:
 - lib/xlearn/model.rb
 - lib/xlearn/utils.rb
 - lib/xlearn/version.rb
+- vendor/LICENSE
+- vendor/NOTICE
+- vendor/libxlearn_api.dylib
+- vendor/libxlearn_api.so
+- vendor/xlearn_api.dll
 homepage: https://github.com/ankane/xlearn
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -103,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: xLearn - the high performance machine learning library - for Ruby
+summary: High performance factorization machines for Ruby
 test_files: []