libmf 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 316a859127d3ee4a6b2af41599daf5d14e1f436479dfd8d1c8ebd739b8141367
-  data.tar.gz: 59b64d67f90955b81630873bc2b776cbf5a463174502ccd3f9e92eb29810eac9
+  metadata.gz: 58c3cf0afbb36ff976cb7641104f363795499023ce04c859beedf17bccaaffa1
+  data.tar.gz: '09a6b70c631ae252b24bd83c3cbb08ff3a9468d6b174b0255cf8223aaf77ea4d'
 SHA512:
-  metadata.gz: 8b2d80a014a92dd78533e31476909aac348906ab0caba74d30826e9f7057bb5f9dd649f10c49d2d436325dbdedc8b590ab031c65197cc4c1b8be6290f525ace9
-  data.tar.gz: 9af9ef4372b7ed124bc3cbdc823e3dfbfc1e10303c914895fbaa608f5959a6de560349148cc6a83e35ef002409042705af198d5f533fbc0e3a87c6fbce0a438b
+  metadata.gz: ad1aad8cdb571fd5fa99aa121a67cf172f6686b793a89a82b555005116378a07772c6675e20308f8575419d618edfa368c0adef738da06847f0c06e860ab650e
+  data.tar.gz: 87f4260c2bccc5f5da8c44497d656fd367467b1d403de6584d802700359f455e55e7f9cbf71db515a5252012e27ace4cf52f5e284528b05a1a6b0be72c693a0d

data/CHANGELOG.md

@@ -1,16 +1,23 @@
-## 0.1.3
+## 0.2.0 (2020-03-26)
+
+- Changed to BSD 3-Clause license to match LIBMF
+- Added support for reading data directly from files
+- Added `format: :numo` option to `p_factors` and `q_factors`
+- Improved performance of loading data by 5x
+
+## 0.1.3 (2019-11-07)
 
 - Made parameter names more Ruby-like
 - No need to set `do_nmf` with generalized KL-divergence
 
-## 0.1.2
+## 0.1.2 (2019-11-06)
 
 - Fixed bug in `p_factors` and `q_factors` methods
 
-## 0.1.1
+## 0.1.1 (2019-11-05)
 
 - Fixed errors on Linux and Windows
 
-## 0.1.0
+## 0.1.0 (2019-11-04)
 
 - First release

data/LICENSE.txt

@@ -1,22 +1,29 @@
-Copyright (c) 2019 Andrew Kane
+BSD 3-Clause License
 
-MIT License
+Copyright (c) 2019-2020, 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

@@ -2,7 +2,9 @@
 
 [LIBMF](https://github.com/cjlin1/libmf) - large-scale sparse matrix factorization - for Ruby
 
-[![Build Status](https://travis-ci.org/ankane/libmf.svg?branch=master)](https://travis-ci.org/ankane/libmf)
+Check out [Disco](https://github.com/ankane/disco) for higher-level collaborative filtering
+
+[![Build Status](https://travis-ci.org/ankane/libmf.svg?branch=master)](https://travis-ci.org/ankane/libmf) [![Build status](https://ci.appveyor.com/api/projects/status/92fbip1bd8sjd2tj/branch/master?svg=true)](https://ci.appveyor.com/project/ankane/libmf/branch/master)
 
 ## Installation
 
@@ -96,8 +98,7 @@ Libmf::Model.new(
   alpha: 0.1,             # importance of negative entries
   c: 0.0001,              # desired value of negative entries
   nmf: false,             # perform non-negative MF (NMF)
-  quiet: false,           # no outputs to stdout
-  copy_data: true         # copy data in training procedure
+  quiet: false            # no outputs to stdout
 )
 ```
 
@@ -121,6 +122,32 @@ For one-class matrix factorization
 - 11 - column-oriented pair-wise logarithmic loss
 - 12 - squared error (L2-norm)
 
+## Performance
+
+For performance, read data directly from files
+
+```ruby
+model.fit("train.txt", eval_set: "validate.txt")
+model.cv("train.txt")
+```
+
+Data should be in the format `row_index column_index value`:
+
+```txt
+0 0 5.0
+0 2 3.5
+1 1 4.0
+```
+
+## Numo
+
+Get latent factors as Numo arrays
+
+```ruby
+model.p_factors(format: :numo)
+model.q_factors(format: :numo)
+```
+
 ## Resources
 
 - [LIBMF: A Library for Parallel Matrix Factorization in Shared-memory Systems](https://www.csie.ntu.edu.tw/~cjlin/papers/libmf/libmf_open_source.pdf)
@@ -137,3 +164,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/libmf/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone --recursive https://github.com/ankane/libmf.git
+cd libmf
+bundle install
+bundle exec rake vendor:all
+bundle exec rake test
+```

data/lib/libmf.rb

@@ -11,15 +11,16 @@ module Libmf
   class << self
     attr_accessor :ffi_lib
   end
-  lib_path =
-    if ::FFI::Platform.windows?
-      "../vendor/libmf/windows/mf.dll"
-    elsif ::FFI::Platform.mac?
-      "libmf.bundle"
+  lib_name =
+    if Gem.win_platform?
+      "mf.dll"
+    elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
+      "libmf.dylib"
     else
       "libmf.so"
     end
-  self.ffi_lib = [File.expand_path(lib_path, __dir__)]
+  vendor_lib = File.expand_path("../vendor/#{lib_name}", __dir__)
+  self.ffi_lib = [vendor_lib]
 
   # friendlier error message
   autoload :FFI, "libmf/ffi"

data/lib/libmf/ffi.rb

@@ -2,12 +2,7 @@ module Libmf
   module FFI
     extend ::FFI::Library
 
-    begin
-      ffi_lib Libmf.ffi_lib
-    rescue LoadError => e
-      raise e if ENV["LIBMF_DEBUG"]
-      raise LoadError, "Could not find LIBMF"
-    end
+    ffi_lib Libmf.ffi_lib
 
     class Node < ::FFI::Struct
       layout :u, :int,
@@ -51,6 +46,7 @@ module Libmf
     end
 
     attach_function :mf_get_default_param, [], Parameter.by_value
+    attach_function :mf_read_problem, [:string], Problem.by_value
     attach_function :mf_save_model, [Model.by_ref, :string], :int
     attach_function :mf_load_model, [:string], Model.by_ref
     attach_function :mf_destroy_model, [Model.by_ref], :void

data/lib/libmf/model.rb

@@ -51,16 +51,27 @@ module Libmf
       model[:b]
     end
 
-    def p_factors
-      reshape(model[:p].read_array_of_float(factors * rows), factors)
+    def p_factors(format: nil)
+      _factors(model[:p], rows, format)
     end
 
-    def q_factors
-      reshape(model[:q].read_array_of_float(factors * columns), factors)
+    def q_factors(format: nil)
+      _factors(model[:q], columns, format)
     end
 
     private
 
+    def _factors(ptr, n, format)
+      case format
+      when :numo
+        Numo::SFloat.from_string(ptr.read_bytes(n * factors * 4)).reshape(n, factors)
+      when nil
+        ptr.read_array_of_float(n * factors).each_slice(factors).to_a
+      else
+        raise ArgumentError, "Invalid format"
+      end
+    end
+
     def model
       raise Error, "Not fit" unless @model
       @model
@@ -71,6 +82,7 @@ module Libmf
       options = @options.dup
       # silence insufficient blocks warning with default params
       options[:bins] ||= 25 unless options[:nr_bins]
+      options[:copy_data] = false unless options.key?(:copy_data)
       options_map = {
         :loss => :fun,
         :factors => :k,
@@ -90,31 +102,37 @@ module Libmf
     end
 
     def create_problem(data)
+      if data.is_a?(String)
+        # need to expand path so it's absolute
+        return FFI.mf_read_problem(File.expand_path(data))
+      end
+
       raise Error, "No data" if data.empty?
 
-      nodes = []
-      r = ::FFI::MemoryPointer.new(FFI::Node, data.size)
-      data.each_with_index do |row, i|
-        n = FFI::Node.new(r[i])
-        n[:u] = row[0]
-        n[:v] = row[1]
-        n[:r] = row[2]
-        nodes << n
+      # TODO do in C for better performance
+      # can use FIX2INT() and RFLOAT_VALUE() instead of pack
+      buffer = String.new
+      data.each do |row|
+        row[0, 2].pack("i*".freeze, buffer: buffer)
+        row[2, 1].pack("f".freeze, buffer: buffer)
       end
 
-      m = nodes.map { |n| n[:u] }.max + 1
-      n = nodes.map { |n| n[:v] }.max + 1
+      r = ::FFI::MemoryPointer.new(FFI::Node, data.size)
+      r.write_bytes(buffer)
+
+      # double check size is what we expect
+      # FFI will throw an error above if too long
+      raise Error, "Bad buffer size" if r.size != buffer.bytesize
+
+      m = data.max_by { |r| r[0] }[0] + 1
+      n = data.max_by { |r| r[1] }[1] + 1
 
       prob = FFI::Problem.new
       prob[:m] = m
       prob[:n] = n
-      prob[:nnz] = nodes.size
+      prob[:nnz] = data.size
       prob[:r] = r
       prob
     end
-
-    def reshape(arr, factors)
-      arr.each_slice(factors).to_a
-    end
   end
 end

data/lib/libmf/version.rb

@@ -1,3 +1,3 @@
 module Libmf
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libmf
 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-11-08 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: benchmark-ips
+  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:
     - - ">="
@@ -83,42 +97,25 @@ dependencies:
 description: 
 email: andrew@chartkick.com
 executables: []
-extensions:
-- ext/libmf/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- ext/libmf/extconf.rb
-- lib/libmf.bundle
 - lib/libmf.rb
 - lib/libmf/ffi.rb
 - lib/libmf/model.rb
 - lib/libmf/version.rb
-- vendor/libmf/COPYRIGHT
-- vendor/libmf/Makefile
-- vendor/libmf/Makefile.win
-- vendor/libmf/README
-- vendor/libmf/demo/all_one_matrix.te.txt
-- vendor/libmf/demo/all_one_matrix.tr.txt
-- vendor/libmf/demo/binary_matrix.te.txt
-- vendor/libmf/demo/binary_matrix.tr.txt
-- vendor/libmf/demo/demo.bat
-- vendor/libmf/demo/demo.sh
-- vendor/libmf/demo/real_matrix.te.txt
-- vendor/libmf/demo/real_matrix.tr.txt
-- vendor/libmf/mf-predict.cpp
-- vendor/libmf/mf-train.cpp
-- vendor/libmf/mf.cpp
-- vendor/libmf/mf.def
-- vendor/libmf/mf.h
-- vendor/libmf/windows/mf-predict.exe
-- vendor/libmf/windows/mf-train.exe
-- vendor/libmf/windows/mf.dll
+- vendor/COPYRIGHT
+- vendor/demo/real_matrix.te.txt
+- vendor/demo/real_matrix.tr.txt
+- vendor/libmf.dylib
+- vendor/libmf.so
+- vendor/mf.dll
 homepage: https://github.com/ankane/libmf
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -135,8 +132,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: LIBMF - large-scale sparse matrix factorization - for Ruby
+summary: Large-scale sparse matrix factorization for Ruby
 test_files: []

data/ext/libmf/extconf.rb

@@ -1,18 +0,0 @@
-require "mkmf"
-
-arch = RbConfig::CONFIG["arch"]
-case arch
-when /mingw/
-  File.write("Makefile", dummy_makefile("libmf").join)
-else
-  abort "Missing stdc++" unless have_library("stdc++")
-  $CXXFLAGS << " -std=c++11"
-
-  # TODO
-  # if have_library("libomp")
-  # end
-
-  $objs = ["mf.o"]
-  vendor_path = File.expand_path("../../vendor/libmf", __dir__)
-  create_makefile("libmf", vendor_path)
-end

data/vendor/libmf/Makefile

@@ -1,34 +0,0 @@
-CXX = g++
-CXXFLAGS = -Wall -O3 -pthread -std=c++0x -march=native
-OMPFLAG = -fopenmp
-SHVER = 2
-
-# run `make clean all' if you change the following flags.
-
-# comment the following flag if you want to disable SSE or enable AVX
-DFLAG = -DUSESSE
-
-# uncomment the following flags if you want to use AVX
-#DFLAG = -DUSEAVX
-#CXXFLAGS += -mavx
-
-# uncomment the following flags if you do not want to use OpenMP
-DFLAG += -DUSEOMP
-CXXFLAGS += $(OMPFLAG)
-
-all: mf-train mf-predict
-
-lib: 
-	$(CXX) -shared -Wl,-soname,libmf.so.$(SHVER) -o libmf.so.$(SHVER) mf.o 
-
-mf-train: mf-train.cpp mf.o
-	$(CXX) $(CXXFLAGS) $(DFLAG) -o $@ $^
-
-mf-predict: mf-predict.cpp mf.o
-	$(CXX) $(CXXFLAGS) $(DFLAG) -o $@ $^
-
-mf.o: mf.cpp mf.h
-	$(CXX) $(CXXFLAGS) $(DFLAG) -c -fPIC -o $@ $<
-
-clean:
-	rm -f mf-train mf-predict mf.o libmf.so.$(SHVER)