vowpalwabbit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa89f06a4117a04e64013f332f75c1ebfd99542c508934430fd511b824fded94
-  data.tar.gz: 00d4b988b39f03ad1a5625e8eccfb427e96ef9488c964e50c7e436c8e2e4e57b
+  metadata.gz: 4dd1b21080c412dc2e9571f7728cd71396f203e85fbc8790b8993ba01414a14d
+  data.tar.gz: 5435815694fa67e2659b72cbc3ceef6c928b89f4f5975754e981899d443f3928
 SHA512:
-  metadata.gz: 37051b8953fddd8f88bc22d2adf66003acfaf8a14beacd4314641616c2e607d5a8c59f572675e94f40759fe142ec491bf6d360493e93f910836ec9db84e909a5
-  data.tar.gz: 2233f54d84f06b8176cf4d37c5cd9387eeaaee06cdfdbd1402bad3fa0117e5f3d1f7df60e453aca8ac17dd5de3ececf1c6db026fb112f9eecf080ecc41e11bb3
+  metadata.gz: 2c0b2950c6ef4f6b185a26198e540f647dc643d0f8e95f751b21cd4d6a157a0ba6216be710d2efb1cf715c74832121c18fcc655ca4462263ff03d1a7bcb02c64
+  data.tar.gz: 54681fcfe2e715576193317949c8e5c78a0e610026fd52e2547eab4873b4966f61b0fa0ae3822445d24248e0e89ef655e9ad7507da2b722862c59336ae028f6f

data/CHANGELOG.md

@@ -1,8 +1,23 @@
-## 0.1.1
+## 0.2.0 (2022-09-02)
+
+- Prefer `save` over `save_model`
+- Prefer `load` over `load_model`
+- Dropped support for Ruby < 2.7
+
+## 0.1.3 (2022-02-02)
+
+- Added support for Ubuntu package
+
+## 0.1.2 (2020-08-18)
+
+- Changed to BSD 3-Clause license to match Vowpal Wabbit
+- Fixed deprecation warning in Ruby 2.7
+
+## 0.1.1 (2019-11-02)
 
 - Added support for compressed files
 - Added support for Numo
 
-## 0.1.0
+## 0.1.0 (2019-10-21)
 
 - First release

data/LICENSE.txt

@@ -1,22 +1,30 @@
-Copyright (c) 2019 Andrew Kane
+BSD 3-Clause License
 
-MIT License
+Copyright (c) Microsoft Corp 2012-2014, Yahoo! Inc. 2007-2012, and many individual contributors
+Copyright (c) 2019-2021, Andrew Kane
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-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.
+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.
+
+3. Neither the name of the copyright holder 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 HOLDER 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.

data/README.md

@@ -1,10 +1,8 @@
-# Vowpal Wabbit
+# Vowpal Wabbit Ruby
 
 [Vowpal Wabbit](https://vowpalwabbit.org) - fast online machine learning - for Ruby
 
-:fire: Uses the C API for blazing performance
-
-[![Build Status](https://travis-ci.org/ankane/vowpalwabbit.svg?branch=master)](https://travis-ci.org/ankane/vowpalwabbit)
+[![Build Status](https://github.com/ankane/vowpalwabbit-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/vowpalwabbit-ruby/actions)
 
 ## Installation
 
@@ -14,10 +12,16 @@ First, install the [Vowpal Wabbit C++ library](https://vowpalwabbit.org/start.ht
 brew install vowpal-wabbit
 ```
 
-Add this line to your application’s Gemfile:
+And for Ubuntu, use:
+
+```sh
+sudo apt install libvw0
+```
+
+Then add this line to your application’s Gemfile:
 
 ```ruby
-gem 'vowpalwabbit'
+gem "vowpalwabbit"
 ```
 
 ## Getting Started
@@ -47,13 +51,13 @@ model.predict(x)
 Save the model to a file
 
 ```ruby
-model.save_model("model.bin")
+model.save("model.bin")
 ```
 
 Load the model from a file
 
 ```ruby
-model.load_model("model.bin")
+model = VowpalWabbit::Regressor.load("model.bin")
 ```
 
 Train online
@@ -93,10 +97,10 @@ Data can be an array of arrays
 [[1, 2, 3], [4, 5, 6]]
 ```
 
-Or a Numo NArray
+Or a Numo array
 
 ```ruby
-Numo::DFloat.new(3, 2).seq
+Numo::NArray.cast([[1, 2, 3], [4, 5, 6]])
 ```
 
 Or an array of strings
@@ -128,13 +132,22 @@ Read more about the [input format](https://github.com/VowpalWabbit/vowpal_wabbit
 
 ## History
 
-View the [changelog](https://github.com/ankane/vowpalwabbit/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/vowpalwabbit-ruby/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/vowpalwabbit/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/vowpalwabbit/pulls)
+- [Report bugs](https://github.com/ankane/vowpalwabbit-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/vowpalwabbit-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/vowpalwabbit-ruby.git
+cd vowpalwabbit-ruby
+bundle install
+bundle exec rake test
+```

data/lib/vowpalwabbit/classifier.rb

@@ -1,7 +1,7 @@
 module VowpalWabbit
   class Classifier < Model
     def initialize(**params)
-      super({loss_function: "logistic"}.merge(params))
+      super(loss_function: "logistic", **params)
     end
 
     def predict(x)

data/lib/vowpalwabbit/model.rb

@@ -46,6 +46,7 @@ module VowpalWabbit
       File.binwrite(filename, bin_str)
       nil
     end
+    alias_method :save, :save_model
 
     def load_model(filename)
       bin_str = File.binread(filename)
@@ -55,6 +56,12 @@ module VowpalWabbit
       nil
     end
 
+    def self.load(filename)
+      model = new
+      model.load_model(filename)
+      model
+    end
+
     private
 
     # TODO clean-up handle
@@ -64,21 +71,21 @@ module VowpalWabbit
 
     def param_str(params)
       args =
-        params.map do |k, v|
+        params.flat_map do |k, v|
           check_param(k.to_s)
           check_param(v.to_s)
 
           if v == true
-            "--#{k}"
+            ["--#{k}"]
           elsif !v
-            nil
+            []
           elsif k.size == 1
-            "-#{k} #{v}"
+            ["-#{k}", v]
           else
-            "--#{k} #{v}"
+            ["--#{k}", v]
           end
         end
-      args.compact.join(" ")
+      args.join(" ")
     end
 
     def check_param(v)

data/lib/vowpalwabbit/version.rb

@@ -1,3 +1,3 @@
 module VowpalWabbit
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/vowpalwabbit.rb

@@ -13,7 +13,7 @@ module VowpalWabbit
   class << self
     attr_accessor :ffi_lib
   end
-  self.ffi_lib = ["vw_c_wrapper"]
+  self.ffi_lib = ["vw_c_wrapper", "libvw_c_wrapper.so.0"]
 
   # friendlier error message
   autoload :FFI, "vowpalwabbit/ffi"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vowpalwabbit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-02 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,64 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  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: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-- !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
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,11 +39,11 @@ files:
 - lib/vowpalwabbit/model.rb
 - lib/vowpalwabbit/regressor.rb
 - lib/vowpalwabbit/version.rb
-homepage: https://github.com/ankane/vowpalwabbit
+homepage: https://github.com/ankane/vowpalwabbit-ruby
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,15 +51,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Vowpal Wabbit - fast online machine learning - for Ruby
+summary: Fast online machine learning for Ruby
 test_files: []