xgb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 148980f8a4991f1f98cd1740188e763a3bd96c98bc69b13a9de9aa00132a12f1
-  data.tar.gz: 31d90a3a064d032a7d1f371c6928f11b103bfc6f9c92dd1697cc538ef33f15fa
+  metadata.gz: 41e23d36cc3404e32f22527f2ddfd112db2abd096fbdbf272bade29d032f0df6
+  data.tar.gz: 5fb377835c2dce3ec1d4f6d734588f3d1e222e9fe35fa9bd127b0eb6198f7f7d
 SHA512:
-  metadata.gz: 28fb08d373af3a3b198822ddea958ca0ee433145dbca091583b25945f27a048a3ec4a4ec43d88dc3c1dde67de7f72b7fb84e7668cfbd173f01d56992017ba4e2
-  data.tar.gz: 5bfb07db7c6b65d0a08010ab59328af75a97e74e025fcd4eb15ca88b05afec3303beb1569c99d59932a5426a64addce1c7fda90562342efcf52fc2c72d9b362a
+  metadata.gz: 6a6551eef35b0c560bccb2e23034cda55ee29bd6dd00840e7d8dc8a86b1df017433d270cbb7b1a812f65d92123c22459722266c7a813b4a9e5184d69ba5abe73
+  data.tar.gz: 4f15acf5555c4a5db81e73113cc5dc0c47f438687d9ea85dae25d818395bd6ed27f162e7a0588c65e347ee51a805eb2d2a673113aad629f6b7903e31f4d5b2ff

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.3
+
+- Added support for missing values
+- Fixed Daru training and prediction
+- Fixed error with JRuby
+
 ## 0.1.2
 
 - Friendlier message when XGBoost not found

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -8,7 +8,11 @@
 
 ## Installation
 
-First, [install XGBoost](https://xgboost.readthedocs.io/en/latest/build.html). On Mac, copy `lib/libxgboost.dylib` to `/usr/local/lib`.
+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:
 
@@ -18,22 +22,29 @@ gem 'xgb'
 
 ## Getting Started
 
-This library follows the [Python API](https://xgboost.readthedocs.io/en/latest/python/python_api.html). 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. Some methods and options are missing at the moment. PRs welcome!
 
 ## Learning API
 
+Prep your data
+
+```ruby
+x = [[1, 2], [3, 4], [5, 6], [7, 8]]
+y = [1, 2, 3, 4]
+```
+
 Train a model
 
 ```ruby
 params = {objective: "reg:squarederror"}
-dtrain = Xgb::DMatrix.new(x_train, label: y_train)
+dtrain = Xgb::DMatrix.new(x, label: y)
 booster = Xgb.train(params, dtrain)
 ```
 
 Predict
 
 ```ruby
-dtest = Xgb::DMatrix.new(x_test)
+dtest = Xgb::DMatrix.new(x)
 booster.predict(dtest)
 ```
 
@@ -137,6 +148,24 @@ 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)
@@ -149,7 +178,7 @@ Numo::DFloat.new(3, 2).seq
 
 ## Credits
 
-Thanks to the [xgboost](https://github.com/PairOnAir/xgboost-ruby) gem for serving as an initial reference, and Selva Prabhakaran for the [test datasets](https://github.com/selva86/datasets).
+Thanks to the [xgboost](https://github.com/PairOnAir/xgboost-ruby) gem for serving as an initial reference.
 
 ## History
 

data/lib/xgb/booster.rb

@@ -53,7 +53,7 @@ module Xgb
       out_len = ::FFI::MemoryPointer.new(:uint64)
       out_result = ::FFI::MemoryPointer.new(:pointer)
       check_result FFI.XGBoosterPredict(handle_pointer, data.handle_pointer, 0, ntree_limit, out_len, out_result)
-      out = out_result.read_pointer.read_array_of_float(out_len.read_uint64)
+      out = out_result.read_pointer.read_array_of_float(read_uint64(out_len))
       num_class = out.size / data.num_row
       out = out.each_slice(num_class).to_a if num_class > 1
       out
@@ -68,7 +68,7 @@ module Xgb
       out_len = ::FFI::MemoryPointer.new(:uint64)
       out_result = ::FFI::MemoryPointer.new(:pointer)
       check_result FFI.XGBoosterDumpModelEx(handle_pointer, fmap, with_stats ? 1 : 0, dump_format, out_len, out_result)
-      out_result.read_pointer.get_array_of_string(0, out_len.read_uint64)
+      out_result.read_pointer.get_array_of_string(0, read_uint64(out_len))
     end
 
     def dump_model(fout, fmap: "", with_stats: false, dump_format: "text")

data/lib/xgb/dmatrix.rb

@@ -14,7 +14,7 @@ module Xgb
           flat_data = data.to_a.flatten
         elsif daru?(data)
           nrow, ncol = data.shape
-          flat_data = data.each_vector.map(&:to_a).flatten
+          flat_data = data.map_rows(&:to_a).flatten
         elsif narray?(data)
           nrow, ncol = data.shape
           flat_data = data.flatten.to_a
@@ -24,6 +24,7 @@ module Xgb
           flat_data = data.flatten
         end
 
+        handle_missing(flat_data, missing)
         c_data = ::FFI::MemoryPointer.new(:float, nrow * ncol)
         c_data.put_array_of_float(0, flat_data)
         check_result FFI.XGDMatrixCreateFromMat(c_data, nrow, ncol, missing, @handle)
@@ -31,8 +32,8 @@ module Xgb
         ObjectSpace.define_finalizer(self, self.class.finalize(handle_pointer))
       end
 
-      set_float_info("label", label) if label
-      set_float_info("weight", weight) if weight
+      self.label = label if label
+      self.weight = weight if weight
     end
 
     def self.finalize(pointer)
@@ -48,6 +49,14 @@ module Xgb
       float_info("weight")
     end
 
+    def label=(label)
+      set_float_info("label", label)
+    end
+
+    def weight=(weight)
+      set_float_info("weight", weight)
+    end
+
     def group=(group)
       c_data = ::FFI::MemoryPointer.new(:int, group.size)
       c_data.put_array_of_int(0, group)
@@ -57,13 +66,13 @@ module Xgb
     def num_row
       out = ::FFI::MemoryPointer.new(:uint64)
       check_result FFI.XGDMatrixNumRow(handle_pointer, out)
-      out.read_uint64
+      read_uint64(out)
     end
 
     def num_col
       out = ::FFI::MemoryPointer.new(:uint64)
       check_result FFI.XGDMatrixNumCol(handle_pointer, out)
-      out.read_uint64
+      read_uint64(out)
     end
 
     def slice(rindex)
@@ -115,6 +124,10 @@ module Xgb
       defined?(Numo::NArray) && data.is_a?(Numo::NArray)
     end
 
+    def handle_missing(data, missing)
+      data.map! { |v| v.nil? ? missing : v }
+    end
+
     include Utils
   end
 end

data/lib/xgb/utils.rb

@@ -9,5 +9,10 @@ module Xgb
         raise Xgb::Error, message
       end
     end
+
+    # read_uint64 not available on JRuby
+    def read_uint64(ptr)
+      ptr.read_array_of_uint64(1).first
+    end
   end
 end

data/lib/xgb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xgb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,20 +80,6 @@ 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: []
@@ -101,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE.txt
 - README.md
 - lib/xgb.rb
 - lib/xgb/booster.rb