xgb 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e23d36cc3404e32f22527f2ddfd112db2abd096fbdbf272bade29d032f0df6
-  data.tar.gz: 5fb377835c2dce3ec1d4f6d734588f3d1e222e9fe35fa9bd127b0eb6198f7f7d
+  metadata.gz: ea879f0494a877766dd500203b7f4ec091607a0a0cae609bc3be50fb134b87eb
+  data.tar.gz: 1ff52f49405628aa837f4f6ff1558b4b1a624a311b4c359c0a0703499613d35d
 SHA512:
-  metadata.gz: 6a6551eef35b0c560bccb2e23034cda55ee29bd6dd00840e7d8dc8a86b1df017433d270cbb7b1a812f65d92123c22459722266c7a813b4a9e5184d69ba5abe73
-  data.tar.gz: 4f15acf5555c4a5db81e73113cc5dc0c47f438687d9ea85dae25d818395bd6ed27f162e7a0588c65e347ee51a805eb2d2a673113aad629f6b7903e31f4d5b2ff
+  metadata.gz: cd2dcbbc2300bbb5900ae1cdf8abe47fd2c0f0c8dc1b825f53c5988450405298e5b8693be243ed351f7f14715e9f5963eb7c00cd39c1b25983b449398804e6f5
+  data.tar.gz: 969c4472a3926f8cd6569269817086ed047e4e64132fd92ab1bb78ab5e8f294c3a4342cfc4e121b8a2866b8f534d1ffaa35b806d9968f198f87bb4de06a64348

data/CHANGELOG.md

@@ -1,17 +1,24 @@
-## 0.1.3
+## 0.2.0 (2020-01-26)
+
+- Prefer `XGBoost` over `Xgb`
+- Changed to Apache 2.0 license to match XGBoost
+- Added shared libraries
+- Added support for booster attributes
+
+## 0.1.3 (2019-10-27)
 
 - Added support for missing values
 - Fixed Daru training and prediction
 - Fixed error with JRuby
 
-## 0.1.2
+## 0.1.2 (2019-08-19)
 
 - Friendlier message when XGBoost not found
 - Free memory when objects are destroyed
 - Added `Ranker`
 - Added early stopping to Scikit-Learn API
 
-## 0.1.1
+## 0.1.1 (2019-08-16)
 
 - Added Scikit-Learn API
 - Added early stopping
@@ -20,6 +27,6 @@
 - Added many other methods
 - Fixed shape of multiclass predictions when loaded from file
 
-## 0.1.0
+## 0.1.0 (2019-08-15)
 
 - 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,13 @@
+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

@@ -1,19 +1,11 @@
-# Xgb
+# XGBoost
 
-[XGBoost](https://github.com/dmlc/xgboost) - the high performance machine learning library - for Ruby
+[XGBoost](https://github.com/dmlc/xgboost) - high performance gradient boosting - for Ruby
 
-:fire: Uses the C API for blazing performance
-
-[![Build Status](https://travis-ci.org/ankane/xgb.svg?branch=master)](https://travis-ci.org/ankane/xgb)
+[![Build Status](https://travis-ci.org/ankane/xgboost.svg?branch=master)](https://travis-ci.org/ankane/xgboost)
 
 ## Installation
 
-First, [install XGBoost](https://xgboost.readthedocs.io/en/latest/build.html). For Homebrew, use:
-
-```sh
-brew install xgboost
-```
-
 Add this line to your application’s Gemfile:
 
 ```ruby
@@ -22,7 +14,7 @@ gem 'xgb'
 
 ## Getting Started
 
-This library follows the [Python API](https://xgboost.readthedocs.io/en/latest/python/python_api.html), with the `get_` and `set_` prefixes removed from methods. Some methods and options are missing at the moment. PRs welcome!
+This library follows the [Python API](https://xgboost.readthedocs.io/en/latest/python/python_api.html), with the `get_` and `set_` prefixes removed from methods to make it more Ruby-like.
 
 ## Learning API
 
@@ -37,14 +29,14 @@ Train a model
 
 ```ruby
 params = {objective: "reg:squarederror"}
-dtrain = Xgb::DMatrix.new(x, label: y)
-booster = Xgb.train(params, dtrain)
+dtrain = XGBoost::DMatrix.new(x, label: y)
+booster = XGBoost.train(params, dtrain)
 ```
 
 Predict
 
 ```ruby
-dtest = Xgb::DMatrix.new(x)
+dtest = XGBoost::DMatrix.new(x)
 booster.predict(dtest)
 ```
 
@@ -57,7 +49,7 @@ booster.save_model("my.model")
 Load the model from a file
 
 ```ruby
-booster = Xgb::Booster.new(model_file: "my.model")
+booster = XGBoost::Booster.new(model_file: "my.model")
 ```
 
 Get the importance of features
@@ -69,13 +61,20 @@ booster.score
 Early stopping
 
 ```ruby
-Xgb.train(params, dtrain, evals: [[dtrain, "train"], [dtest, "eval"]], early_stopping_rounds: 5)
+XGBoost.train(params, dtrain, evals: [[dtrain, "train"], [dtest, "eval"]], early_stopping_rounds: 5)
 ```
 
 CV
 
 ```ruby
-Xgb.cv(params, dtrain, nfold: 3, verbose_eval: true)
+XGBoost.cv(params, dtrain, nfold: 3, verbose_eval: true)
+```
+
+Set metadata about a model [master]
+
+```ruby
+booster["key"] = "value"
+booster.attributes
 ```
 
 ## Scikit-Learn API
@@ -90,11 +89,11 @@ y = [1, 2, 3, 4]
 Train a model
 
 ```ruby
-model = Xgb::Regressor.new
+model = XGBoost::Regressor.new
 model.fit(x, y)
 ```
 
-> For classification, use `Xgb::Classifier`
+> For classification, use `XGBoost::Classifier`
 
 Predict
 
@@ -148,24 +147,6 @@ Or a Numo NArray
 Numo::DFloat.new(3, 2).seq
 ```
 
-## XGBoost Installation
-
-There’s an experimental branch that includes XGBoost with the gem for easiest installation.
-
-```ruby
-gem 'xgb', github: 'ankane/xgb', branch: 'vendor', submodules: true
-```
-
-Please file an issue if it doesn’t work for you.
-
-You can also specify the path to XGBoost in an initializer:
-
-```ruby
-Xgb.ffi_lib << "/path/to/xgboost/lib/libxgboost.so"
-```
-
-> Use `libxgboost.dylib` for Mac and `xgboost.dll` for Windows
-
 ## Helpful Resources
 
 - [Parameters](https://xgboost.readthedocs.io/en/latest/parameter.html)
@@ -182,13 +163,22 @@ Thanks to the [xgboost](https://github.com/PairOnAir/xgboost-ruby) gem for servi
 
 ## History
 
-View the [changelog](https://github.com/ankane/xgb/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/xgboost/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/xgb/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/xgb/pulls)
+- [Report bugs](https://github.com/ankane/xgboost/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/xgboost/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/xgboost.git
+cd xgboost
+bundle install
+bundle exec rake test
+```

data/lib/xgb.rb

@@ -1,173 +1,4 @@
-# dependencies
-require "ffi"
+require "xgboost"
 
-# modules
-require "xgb/utils"
-require "xgb/booster"
-require "xgb/dmatrix"
-require "xgb/version"
-
-# scikit-learn API
-require "xgb/model"
-require "xgb/classifier"
-require "xgb/ranker"
-require "xgb/regressor"
-
-module Xgb
-  class Error < StandardError; end
-
-  class << self
-    attr_accessor :ffi_lib
-  end
-  self.ffi_lib = ["xgboost"]
-
-  # friendlier error message
-  autoload :FFI,"xgb/ffi"
-
-  class << self
-    def train(params, dtrain, num_boost_round: 10, evals: nil, early_stopping_rounds: nil, verbose_eval: true)
-      booster = Booster.new(params: params)
-      num_feature = dtrain.num_col
-      booster.set_param("num_feature", num_feature)
-      booster.feature_names = num_feature.times.map { |i| "f#{i}" }
-      evals ||= []
-
-      if early_stopping_rounds
-        best_score = nil
-        best_iter = nil
-        best_message = nil
-      end
-
-      num_boost_round.times do |iteration|
-        booster.update(dtrain, iteration)
-
-        if evals.any?
-          message = booster.eval_set(evals, iteration)
-          res = message.split.map { |x| x.split(":") }[1..-1].map { |k, v| [k, v.to_f] }
-
-          if early_stopping_rounds && iteration == 0
-            metric = res[-1][0]
-            puts "Will train until #{metric} hasn't improved in #{early_stopping_rounds.to_i} rounds." if verbose_eval
-          end
-
-          puts message if verbose_eval
-          score = res[-1][1]
-
-          # TODO handle larger better
-          if best_score.nil? || score < best_score
-            best_score = score
-            best_iter = iteration
-            best_message = message
-          elsif iteration - best_iter >= early_stopping_rounds
-            booster.best_iteration = best_iter
-            puts "Stopping. Best iteration:\n#{best_message}" if verbose_eval
-            break
-          end
-        end
-      end
-
-      booster
-    end
-
-    def cv(params, dtrain, num_boost_round: 10, nfold: 3, seed: 0, shuffle: true, verbose_eval: nil, show_stdv: true, early_stopping_rounds: nil)
-      rand_idx = (0...dtrain.num_row).to_a
-      rand_idx.shuffle!(random: Random.new(seed)) if shuffle
-
-      kstep = (rand_idx.size / nfold.to_f).ceil
-      test_id = rand_idx.each_slice(kstep).to_a[0...nfold]
-      train_id = []
-      nfold.times do |i|
-        idx = test_id.dup
-        idx.delete_at(i)
-        train_id << idx.flatten
-      end
-
-      folds = train_id.zip(test_id)
-      cvfolds = []
-      folds.each do |(train_idx, test_idx)|
-        fold_dtrain = dtrain.slice(train_idx)
-        fold_dvalid = dtrain.slice(test_idx)
-        booster = Booster.new(params: params)
-        booster.set_param("num_feature", dtrain.num_col)
-        cvfolds << [booster, fold_dtrain, fold_dvalid]
-      end
-
-      eval_hist = {}
-
-      if early_stopping_rounds
-        best_score = nil
-        best_iter = nil
-      end
-
-      num_boost_round.times do |iteration|
-        scores = {}
-
-        cvfolds.each do |(booster, fold_dtrain, fold_dvalid)|
-          booster.update(fold_dtrain, iteration)
-          message = booster.eval_set([[fold_dtrain, "train"], [fold_dvalid, "test"]], iteration)
-
-          res = message.split.map { |x| x.split(":") }[1..-1].map { |k, v| [k, v.to_f] }
-          res.each do |k, v|
-            (scores[k] ||= []) << v
-          end
-        end
-
-        message_parts = ["[#{iteration}]"]
-
-        last_mean = nil
-        means = {}
-        scores.each do |eval_name, vals|
-          mean = mean(vals)
-          stdev = stdev(vals)
-
-          (eval_hist["#{eval_name}-mean"] ||= []) << mean
-          (eval_hist["#{eval_name}-std"] ||= []) << stdev
-
-          means[eval_name] = mean
-          last_mean = mean
-
-          if show_stdv
-            message_parts << "%s:%g+%g" % [eval_name, mean, stdev]
-          else
-            message_parts << "%s:%g" % [eval_name, mean]
-          end
-        end
-
-        if early_stopping_rounds
-          score = last_mean
-          # TODO handle larger better
-          if best_score.nil? || score < best_score
-            best_score = score
-            best_iter = iteration
-          elsif iteration - best_iter >= early_stopping_rounds
-            eval_hist.each_key do |k|
-              eval_hist[k] = eval_hist[k][0..best_iter]
-            end
-            break
-          end
-        end
-
-        # put at end to keep output consistent with Python
-        puts message_parts.join("\t") if verbose_eval
-      end
-
-      eval_hist
-    end
-
-    private
-
-    def mean(arr)
-      arr.sum / arr.size.to_f
-    end
-
-    # don't subtract one from arr.size
-    def stdev(arr)
-      m = mean(arr)
-      sum = 0
-      arr.each do |v|
-        sum += (v - m) ** 2
-      end
-      Math.sqrt(sum / arr.size)
-    end
-  end
-end
+# legacy
+Xgb = XGBoost

data/lib/xgboost.rb

@@ -0,0 +1,175 @@
+# dependencies
+require "ffi"
+
+# modules
+require "xgboost/utils"
+require "xgboost/booster"
+require "xgboost/dmatrix"
+require "xgboost/version"
+
+# scikit-learn API
+require "xgboost/model"
+require "xgboost/classifier"
+require "xgboost/ranker"
+require "xgboost/regressor"
+
+module XGBoost
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :ffi_lib
+  end
+  lib_name = FFI.map_library_name("xgboost")
+  vendor_lib = File.expand_path("../vendor/#{lib_name}", __dir__)
+  self.ffi_lib = [vendor_lib]
+
+  # friendlier error message
+  autoload :FFI, "xgboost/ffi"
+
+  class << self
+    def train(params, dtrain, num_boost_round: 10, evals: nil, early_stopping_rounds: nil, verbose_eval: true)
+      booster = Booster.new(params: params)
+      num_feature = dtrain.num_col
+      booster.set_param("num_feature", num_feature)
+      booster.feature_names = num_feature.times.map { |i| "f#{i}" }
+      evals ||= []
+
+      if early_stopping_rounds
+        best_score = nil
+        best_iter = nil
+        best_message = nil
+      end
+
+      num_boost_round.times do |iteration|
+        booster.update(dtrain, iteration)
+
+        if evals.any?
+          message = booster.eval_set(evals, iteration)
+          res = message.split.map { |x| x.split(":") }[1..-1].map { |k, v| [k, v.to_f] }
+
+          if early_stopping_rounds && iteration == 0
+            metric = res[-1][0]
+            puts "Will train until #{metric} hasn't improved in #{early_stopping_rounds.to_i} rounds." if verbose_eval
+          end
+
+          puts message if verbose_eval
+          score = res[-1][1]
+
+          # TODO handle larger better
+          if best_score.nil? || score < best_score
+            best_score = score
+            best_iter = iteration
+            best_message = message
+          elsif iteration - best_iter >= early_stopping_rounds
+            booster.best_iteration = best_iter
+            puts "Stopping. Best iteration:\n#{best_message}" if verbose_eval
+            break
+          end
+        end
+      end
+
+      booster
+    end
+
+    def cv(params, dtrain, num_boost_round: 10, nfold: 3, seed: 0, shuffle: true, verbose_eval: nil, show_stdv: true, early_stopping_rounds: nil)
+      rand_idx = (0...dtrain.num_row).to_a
+      rand_idx.shuffle!(random: Random.new(seed)) if shuffle
+
+      kstep = (rand_idx.size / nfold.to_f).ceil
+      test_id = rand_idx.each_slice(kstep).to_a[0...nfold]
+      train_id = []
+      nfold.times do |i|
+        idx = test_id.dup
+        idx.delete_at(i)
+        train_id << idx.flatten
+      end
+
+      folds = train_id.zip(test_id)
+      cvfolds = []
+      folds.each do |(train_idx, test_idx)|
+        fold_dtrain = dtrain.slice(train_idx)
+        fold_dvalid = dtrain.slice(test_idx)
+        booster = Booster.new(params: params)
+        booster.set_param("num_feature", dtrain.num_col)
+        cvfolds << [booster, fold_dtrain, fold_dvalid]
+      end
+
+      eval_hist = {}
+
+      if early_stopping_rounds
+        best_score = nil
+        best_iter = nil
+      end
+
+      num_boost_round.times do |iteration|
+        scores = {}
+
+        cvfolds.each do |(booster, fold_dtrain, fold_dvalid)|
+          booster.update(fold_dtrain, iteration)
+          message = booster.eval_set([[fold_dtrain, "train"], [fold_dvalid, "test"]], iteration)
+
+          res = message.split.map { |x| x.split(":") }[1..-1].map { |k, v| [k, v.to_f] }
+          res.each do |k, v|
+            (scores[k] ||= []) << v
+          end
+        end
+
+        message_parts = ["[#{iteration}]"]
+
+        last_mean = nil
+        means = {}
+        scores.each do |eval_name, vals|
+          mean = mean(vals)
+          stdev = stdev(vals)
+
+          (eval_hist["#{eval_name}-mean"] ||= []) << mean
+          (eval_hist["#{eval_name}-std"] ||= []) << stdev
+
+          means[eval_name] = mean
+          last_mean = mean
+
+          if show_stdv
+            message_parts << "%s:%g+%g" % [eval_name, mean, stdev]
+          else
+            message_parts << "%s:%g" % [eval_name, mean]
+          end
+        end
+
+        if early_stopping_rounds
+          score = last_mean
+          # TODO handle larger better
+          if best_score.nil? || score < best_score
+            best_score = score
+            best_iter = iteration
+          elsif iteration - best_iter >= early_stopping_rounds
+            eval_hist.each_key do |k|
+              eval_hist[k] = eval_hist[k][0..best_iter]
+            end
+            break
+          end
+        end
+
+        # put at end to keep output consistent with Python
+        puts message_parts.join("\t") if verbose_eval
+      end
+
+      eval_hist
+    end
+
+    private
+
+    def mean(arr)
+      arr.sum / arr.size.to_f
+    end
+
+    # don't subtract one from arr.size
+    def stdev(arr)
+      m = mean(arr)
+      sum = 0
+      arr.each do |v|
+        sum += (v - m) ** 2
+      end
+      Math.sqrt(sum / arr.size)
+    end
+  end
+end

data/lib/{xgb → xgboost}/booster.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class Booster
     attr_accessor :best_iteration, :feature_names
 
@@ -154,6 +154,34 @@ module Xgb
       end
     end
 
+    def [](key_name)
+      key = ::FFI::MemoryPointer.from_string(key_name)
+      success = ::FFI::MemoryPointer.new(:int)
+      out_result = ::FFI::MemoryPointer.new(:pointer)
+
+      check_result FFI.XGBoosterGetAttr(handle_pointer, key, out_result, success)
+
+      success.read_int == 1 ? out_result.read_pointer.read_string : nil
+    end
+
+    def []=(key_name, raw_value)
+      key = ::FFI::MemoryPointer.from_string(key_name)
+      value = raw_value.nil? ? nil : ::FFI::MemoryPointer.from_string(raw_value)
+
+      check_result FFI.XGBoosterSetAttr(handle_pointer, key, value)
+    end
+
+    def attributes
+      out_len = ::FFI::MemoryPointer.new(:uint64)
+      out_result = ::FFI::MemoryPointer.new(:pointer)
+      check_result FFI.XGBoosterGetAttrNames(handle_pointer, out_len, out_result)
+
+      len = read_uint64(out_len)
+      key_names = len.zero? ? [] : out_result.read_pointer.get_array_of_string(0, len)
+
+      key_names.map { |key_name| [key_name, self[key_name]] }.to_h
+    end
+
     private
 
     def handle_pointer

data/lib/{xgb → xgboost}/classifier.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class Classifier < Model
     def initialize(max_depth: 3, learning_rate: 0.1, n_estimators: 100, objective: "binary:logistic", importance_type: "gain", **options)
       super
@@ -16,7 +16,7 @@ module Xgb
       dtrain = DMatrix.new(x, label: y)
       evals = Array(eval_set).map.with_index { |v, i| [DMatrix.new(v[0], label: v[1]), "validation_#{i}"] }
 
-      @booster = Xgb.train(params, dtrain,
+      @booster = XGBoost.train(params, dtrain,
         num_boost_round: @n_estimators,
         early_stopping_rounds: early_stopping_rounds,
         verbose_eval: verbose,

data/lib/{xgb → xgboost}/dmatrix.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class DMatrix
     attr_reader :data
 
@@ -26,7 +26,7 @@ module Xgb
 
         handle_missing(flat_data, missing)
         c_data = ::FFI::MemoryPointer.new(:float, nrow * ncol)
-        c_data.put_array_of_float(0, flat_data)
+        c_data.write_array_of_float(flat_data)
         check_result FFI.XGDMatrixCreateFromMat(c_data, nrow, ncol, missing, @handle)
 
         ObjectSpace.define_finalizer(self, self.class.finalize(handle_pointer))
@@ -59,7 +59,7 @@ module Xgb
 
     def group=(group)
       c_data = ::FFI::MemoryPointer.new(:int, group.size)
-      c_data.put_array_of_int(0, group)
+      c_data.write_array_of_int(group)
       check_result FFI.XGDMatrixSetGroup(handle_pointer, c_data, group.size)
     end
 
@@ -78,7 +78,7 @@ module Xgb
     def slice(rindex)
       res = DMatrix.new(nil)
       idxset = ::FFI::MemoryPointer.new(:int, rindex.count)
-      idxset.put_array_of_int(0, rindex)
+      idxset.write_array_of_int(rindex)
       check_result FFI.XGDMatrixSliceDMatrix(handle_pointer, idxset, rindex.size, res.handle)
       res
     end
@@ -100,7 +100,7 @@ module Xgb
     def set_float_info(field, data)
       data = data.to_a unless data.is_a?(Array)
       c_data = ::FFI::MemoryPointer.new(:float, data.size)
-      c_data.put_array_of_float(0, data)
+      c_data.write_array_of_float(data)
       check_result FFI.XGDMatrixSetFloatInfo(handle_pointer, field.to_s, c_data, data.size)
     end
 

data/lib/{xgb → xgboost}/ffi.rb

@@ -1,9 +1,9 @@
-module Xgb
+module XGBoost
   module FFI
     extend ::FFI::Library
 
     begin
-      ffi_lib Xgb.ffi_lib
+      ffi_lib XGBoost.ffi_lib
     rescue LoadError => e
       raise e if ENV["XGB_DEBUG"]
       raise LoadError, "Could not find XGBoost"
@@ -36,5 +36,8 @@ module Xgb
     attach_function :XGBoosterLoadModel, %i[pointer string], :int
     attach_function :XGBoosterSaveModel, %i[pointer string], :int
     attach_function :XGBoosterDumpModelEx, %i[pointer string int string pointer pointer], :int
+    attach_function :XGBoosterGetAttr, %i[pointer pointer pointer pointer], :int
+    attach_function :XGBoosterSetAttr, %i[pointer pointer pointer], :int
+    attach_function :XGBoosterGetAttrNames, %i[pointer pointer pointer], :int
   end
 end

data/lib/{xgb → xgboost}/model.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class Model
     attr_reader :booster
 

data/lib/{xgb → xgboost}/ranker.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class Ranker < Model
     def initialize(max_depth: 3, learning_rate: 0.1, n_estimators: 100, objective: "rank:pairwise", importance_type: "gain", **options)
       super
@@ -7,7 +7,7 @@ module Xgb
     def fit(x, y, group)
       dtrain = DMatrix.new(x, label: y)
       dtrain.group = group
-      @booster = Xgb.train(@params, dtrain, num_boost_round: @n_estimators)
+      @booster = XGBoost.train(@params, dtrain, num_boost_round: @n_estimators)
       nil
     end
   end

data/lib/{xgb → xgboost}/regressor.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   class Regressor < Model
     def initialize(max_depth: 3, learning_rate: 0.1, n_estimators: 100, objective: "reg:squarederror", importance_type: "gain", **options)
       super
@@ -8,7 +8,7 @@ module Xgb
       dtrain = DMatrix.new(x, label: y)
       evals = Array(eval_set).map.with_index { |v, i| [DMatrix.new(v[0], label: v[1]), "validation_#{i}"] }
 
-      @booster = Xgb.train(@params, dtrain,
+      @booster = XGBoost.train(@params, dtrain,
         num_boost_round: @n_estimators,
         early_stopping_rounds: early_stopping_rounds,
         verbose_eval: verbose,

data/lib/{xgb → xgboost}/utils.rb

@@ -1,4 +1,4 @@
-module Xgb
+module XGBoost
   module Utils
     private
 
@@ -6,7 +6,7 @@ module Xgb
       if err != 0
         # make friendly
         message = FFI.XGBGetLastError.split("\n").first.split(/:\d+: /, 2).last
-        raise Xgb::Error, message
+        raise XGBoost::Error, message
       end
     end
 

data/lib/xgboost/version.rb

@@ -0,0 +1,3 @@
+module XGBoost
+  VERSION = "0.2.0"
+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 (c) 2019 by 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xgb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !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'
 description: 
 email: andrew@chartkick.com
 executables: []
@@ -88,20 +102,26 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
+- NOTICE.txt
 - README.md
 - lib/xgb.rb
-- lib/xgb/booster.rb
-- lib/xgb/classifier.rb
-- lib/xgb/dmatrix.rb
-- lib/xgb/ffi.rb
-- lib/xgb/model.rb
-- lib/xgb/ranker.rb
-- lib/xgb/regressor.rb
-- lib/xgb/utils.rb
-- lib/xgb/version.rb
-homepage: https://github.com/ankane/xgb
+- lib/xgboost.rb
+- lib/xgboost/booster.rb
+- lib/xgboost/classifier.rb
+- lib/xgboost/dmatrix.rb
+- lib/xgboost/ffi.rb
+- lib/xgboost/model.rb
+- lib/xgboost/ranker.rb
+- lib/xgboost/regressor.rb
+- lib/xgboost/utils.rb
+- lib/xgboost/version.rb
+- vendor/LICENSE
+- vendor/libxgboost.dylib
+- vendor/libxgboost.so
+- vendor/xgboost.dll
+homepage: https://github.com/ankane/xgboost
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -118,8 +138,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: XGBoost - the high performance machine learning library - for Ruby
+summary: High performance gradient boosting for Ruby
 test_files: []

data/lib/xgb/version.rb

@@ -1,3 +0,0 @@
-module Xgb
-  VERSION = "0.1.3"
-end