xgboost 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c395c9bc4b61e328f2b5a34c25974e0156cba8b
-  data.tar.gz: a2c3c597c32a4a8531b840cfbdf05ad5b879dc0d
+  metadata.gz: 055f94dc621ffd0592d84a0dd6204f959b677ffa
+  data.tar.gz: dacbb294c2a47ffb4762e3889dd779cd01fbc1c3
 SHA512:
-  metadata.gz: bf320b80c8aeb33274487a8fecb1678ee6b561a32abc788954ca92bf95cfbed35db8cb83810bd0eedd72b5e3c2efd498c239db3739c9b978e8a2eb442413a6b6
-  data.tar.gz: 2fa7cbc313adf72d5a14e4bdf896f20e33d63385dcc454fa1c489bd618e8295c2fdcd8f2d387c9f4231f264ceffc27de7cc4566302b6962b7301390dfe5c8c6d
+  metadata.gz: ef5817e2e12c6face712d99c2a5a159af6c4c1444b23206ec71b2b17d1990cd8a427710bc51f3e28e70c982da391dc9a53cf6ddcc8733c1e3b7eb5de2736d152
+  data.tar.gz: e90dd7e036b37f510e96558ed8c9f8ba7ea81cf467f8ed3e3511072ae9474012d9a1097a8afa5e90379541340c6b536c5ed0bffdb24905611e891b62faf00a1b

data/bin/install_xgboost

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -e
+set -xv
+
+target="$(dirname $0)/../vendor/xgboost"
+mkdir -p "$target"
+target=$(cd "$target"; pwd -P)
+cd "$target"
+
+if [ ! -d .git ]; then
+  git clone --recurse-submodules https://github.com/dmlc/xgboost .
+else
+  git fetch --recurse-submodules
+fi
+
+if [[ -z "$1" ]]; then
+  git checkout origin/master
+  git submodule update --remote
+else
+  git checkout "$1"
+fi
+
+if [[ "$OSTYPE" == darwin* ]]; then
+  cp make/minimum.mk config.mk
+fi
+
+make --jobs 4

data/lib/xgboost.rb

@@ -1,5 +1,11 @@
-require "xgboost/version"
-require "xgboost/xgboost"
-
 module Xgboost
+  def self.root
+    File.expand_path(File.join('..', '..'), __FILE__)
+  end
+
+  # eager require wouldn't allow people to use `rake xgboost:install`
+  autoload :FFI, 'xgboost/ffi'
 end
+
+require 'xgboost/booster'
+require 'xgboost/version'

data/lib/xgboost/booster.rb

@@ -0,0 +1,54 @@
+require 'ffi'
+
+module Xgboost
+  class Booster
+    def initialize
+      @handle = ::FFI::MemoryPointer.new(:pointer)
+      FFI.XGBoosterCreate(nil, 0, @handle)
+      ObjectSpace.define_finalizer(self, self.class.finalize(handle_pointer))
+    end
+
+    def self.finalize(pointer)
+      proc { FFI.XGBoosterFree(pointer) }
+    end
+
+    def load(path)
+      FFI.XGBoosterLoadModel(handle_pointer, path)
+    end
+
+    def save(path)
+      FFI.XGBoosterSaveModel(handle_pointer, path)
+    end
+
+    def predict(input, missing: Float::NAN)
+      raise TypeError unless input.is_a?(Array)
+
+      unless input_2d = input.first.is_a?(Array)
+        input = [input]
+      end
+
+      out_len = ::FFI::MemoryPointer.new(:ulong_long)
+      out_result = ::FFI::MemoryPointer.new(:pointer)
+
+      data = ::FFI::MemoryPointer.new(:float, input.count * input.first.count)
+      data.put_array_of_float(0, input.flatten)
+
+      dmatrix = ::FFI::MemoryPointer.new(:pointer)
+      FFI.XGDMatrixCreateFromMat(data, input.count, input.first.count, missing, dmatrix)
+
+      FFI.XGBoosterPredict(handle_pointer, dmatrix.read_pointer, 0, 0, out_len, out_result)
+
+      out = out_result.read_pointer.read_array_of_float(out_len.read_ulong_long)
+
+      input_2d ? out : out.first
+    ensure
+      FFI.XGDMatrixFree(dmatrix.read_pointer) if dmatrix
+    end
+
+    private
+
+    def handle_pointer
+      @handle.read_pointer
+    end
+  end
+end

data/lib/xgboost/ffi.rb

@@ -0,0 +1,60 @@
+require 'ffi'
+
+module Xgboost
+  module FFI
+    extend ::FFI::Library
+    lib_name = ::FFI.map_library_name('xgboost')
+    lib_path = File.join(Xgboost.root, 'vendor', 'xgboost', 'lib', lib_name)
+
+    begin
+      ffi_lib ['xgboost', lib_path]
+    rescue LoadError => e
+      abort <<~HELP
+
+        Cannot load libxgboost! Looked in:
+          - /usr/lib
+          - /usr/local/lib
+          - #{lib_path}
+
+        You can either:
+          1. (easiest) Run `rake -r xgboost/rake xgboost:install`
+
+             This will clone and compile the latest version of dmlc/xgboost, as per
+             https://github.com/PairOnAir/xgboost-ruby/tree/v#{VERSION}/bin/install_xgboost.
+
+          2. (easy, stable) Run `rake -r xgboost/rake xgboost:install[GIT_SHA]`
+
+             This will clone and compile the given commit SHA1 of dmlc/xgboost. This way you're
+             making sure you're locking to the same version of XGBoost across development,
+             CI, staging, and production.
+
+          3. (full control) Compile xgboost yourself and put it in /usr/local/lib, e.g.:
+
+             git clone --recurse-submodules https://github.com/dmlc/xgboost.git && cd xgboost && make
+             ln -s $(pwd)/lib/#{lib_name} /usr/local/lib
+             # or: cp $(pwd)/lib/#{lib_name} /usr/local/lib
+
+             Depending on your platform, compiling xgboost from source
+             will probably be more tricky than that, please consult the
+             XGBoost docs for help: http://xgboost.readthedocs.io/en/latest/build.html.
+
+        Exception details:
+        #{e}
+
+      HELP
+    end
+
+    {
+      XGBoosterCreate: %i[ pointer long pointer ],
+      XGBoosterFree: %i[ pointer ],
+      XGBoosterLoadModel: %i[ pointer string ],
+      XGBoosterSaveModel: %i[ pointer string ],
+      XGBoosterPredict: %i[ pointer pointer int uint pointer pointer ],
+      XGDMatrixCreateFromMat: %i[ pointer long long float pointer ],
+      XGDMatrixFree: %i[ pointer ],
+    }.each do |function, args|
+      attach_function function, args, :int
+    end
+
+  end
+end

data/lib/xgboost/rake.rb

@@ -0,0 +1,19 @@
+require 'rake'
+require 'xgboost'
+
+module Xgboost
+  module Rake
+    extend ::Rake::DSL
+
+    def self.add_tasks
+      namespace :xgboost do
+        desc 'Clones and compiles xgboost'
+        task :install, :sha do |_t, args|
+          system(File.join(Xgboost.root, 'bin', 'install_xgboost'), args[:sha])
+        end
+      end
+    end
+  end
+end
+
+Xgboost::Rake.add_tasks

data/lib/xgboost/version.rb

@@ -1,3 +1,3 @@
 module Xgboost
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xgboost
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Harald Wartig
@@ -9,38 +9,38 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -57,41 +57,31 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Ruby binding for XGBoost
 email:
 - hwartig@gmail.com
 - olek.janiszewski@gmail.com
 executables: []
-extensions:
-- ext/xgboost/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- ext/xgboost/extconf.rb
-- ext/xgboost/xgboost.c
-- ext/xgboost/xgboost.h
+- bin/install_xgboost
 - lib/xgboost.rb
+- lib/xgboost/booster.rb
+- lib/xgboost/ffi.rb
+- lib/xgboost/rake.rb
 - lib/xgboost/version.rb
-- xgboost.gemspec
 homepage: https://github.com/paironair/xgboost-ruby
 licenses:
 - MIT
@@ -112,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby binding for XGBoost

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at hwartig@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in xgboost.gemspec
-gemspec

data/README.md

@@ -1,43 +0,0 @@
-# Xgboost
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xgboost`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'xgboost'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install xgboost
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/hwartig/xgboost. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Xgboost project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hwartig/xgboost/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rake/extensiontask"
-
-task :build => :compile
-
-Rake::ExtensionTask.new("xgboost") do |ext|
-  ext.lib_dir = "lib/xgboost"
-end
-
-task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "xgboost"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/ext/xgboost/extconf.rb

@@ -1,3 +0,0 @@
-require "mkmf"
-
-create_makefile("xgboost/xgboost")

data/ext/xgboost/xgboost.c

@@ -1,31 +0,0 @@
-#include "xgboost.h"
-
-VALUE rb_mXgboost;
-
-VALUE rb_xgboost_this_is_c(VALUE klass)
-{
-  VALUE r_result = rb_int_new(42);
-  return r_result;
-}
-
-VALUE rb_xgboost_add_in_c(VALUE klass, VALUE op1, VALUE op2)
-{
-  if (!FIXNUM_P(op1))
-    rb_raise(rb_eArgError, "Argument 1 has to be of type Fixnum");
-
-  if (!FIXNUM_P(op2))
-    rb_raise(rb_eArgError, "Argument 2 has to be of type Fixnum");
-
-  long op1_long = FIX2LONG(op1);
-  long op2_long = FIX2LONG(op2);
-
-  return LONG2FIX(op1_long + op2_long);
-}
-
-void
-Init_xgboost(void)
-{
-  rb_mXgboost = rb_define_module("Xgboost");
-  rb_define_module_function(rb_mXgboost, "this_is_c", rb_xgboost_this_is_c, 0);
-  rb_define_module_function(rb_mXgboost, "add_in_c", rb_xgboost_add_in_c, 2);
-}

data/ext/xgboost/xgboost.h

@@ -1,6 +0,0 @@
-#ifndef XGBOOST_H
-#define XGBOOST_H 1
-
-#include "ruby.h"
-
-#endif /* XGBOOST_H */

data/xgboost.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "xgboost/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "xgboost"
-  spec.version       = Xgboost::VERSION
-  spec.authors       = ["Harald Wartig", "Olek Janiszewski"]
-  spec.email         = ["hwartig@gmail.com", "olek.janiszewski@gmail.com"]
-
-  spec.summary       = %q{Ruby binding for XGBoost}
-  spec.description   = %q{Ruby binding for XGBoost}
-  spec.homepage      = "https://github.com/paironair/xgboost-ruby"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^spec/})
-  end
-  spec.require_paths = ["lib"]
-  spec.extensions    = ["ext/xgboost/extconf.rb"]
-
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rake-compiler"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end