libmf 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e654382e818f1b59bc4437e71bc3e0ae6f4d4d79b9c85aeb53fb3494b2baf888
-  data.tar.gz: 560fa519794c7cd8b29c27b9ac9f4247e0485e9f13f229c18a4562c8bee62868
+  metadata.gz: 33b8ba1c7cf9de8e19fa9775ecdb445bc0f2f4323401cccbf016ff6a81a04a00
+  data.tar.gz: 9ff88bdafac8bbfe0c99ccc0c0b7dfb7a9092246de1105c7f99ccade29b9c88b
 SHA512:
-  metadata.gz: d16fb17f9b58cea5c53814a68fbf9de91440fd77e1669b52bbe5cb3a3837c94449d8bbc348405c0c117f219d2a513f1fc2e813b330ea127c93ac04a0c4101d07
-  data.tar.gz: 3d5d3962d3878fe992f76ef9d2fa5e30866d007cd5ae3ab97a666fc53f97f9f3f2487bb425e15b59becde6118c61ecac6c8511692742d64efa2b9e26fe0d2872
+  metadata.gz: 021eca76e96ceca2cd484b7f7796a649529f3b20c80d494143cfaf43e617d23ac55ae50bdcd345808e277b31d304ea6e6a53c937b3e9a200f47ae226f27e4f2b
+  data.tar.gz: 916b78a5e62d19e4d6a9e1433350bb26982d43393029e4e883ed803f89a03f6db766ab10718120a73db1f0ad7ac80607d475a10a7c203d117ca1706e80618345

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.2.6 (2021-12-02)
+
+- Improved ARM detection
+
+## 0.2.5 (2021-10-18)
+
+- Added named loss functions
+- Added `Matrix` class
+- Improved error checking for `fit`, `cv`, `save_model`, and `load_model`
+
+## 0.2.4 (2021-08-05)
+
+- Fixed memory leak
+
+## 0.2.3 (2021-03-14)
+
+- Added ARM shared library for Linux
+
 ## 0.2.2 (2021-02-04)
 
 - Reduced allocations

data/README.md

@@ -1,10 +1,10 @@
-# LIBMF
+# LIBMF Ruby
 
 [LIBMF](https://github.com/cjlin1/libmf) - large-scale sparse matrix factorization - for Ruby
 
 Check out [Disco](https://github.com/ankane/disco) for higher-level collaborative filtering
 
-[![Build Status](https://github.com/ankane/libmf/workflows/build/badge.svg?branch=master)](https://github.com/ankane/libmf/actions)
+[![Build Status](https://github.com/ankane/libmf-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/libmf-ruby/actions)
 
 ## Installation
 
@@ -16,14 +16,13 @@ gem 'libmf'
 
 ## Getting Started
 
-Prep your data in the format `[row_index, column_index, value]`
+Prep your data in the format `row_index, column_index, value`
 
 ```ruby
-data = [
-  [0, 0, 5.0],
-  [0, 2, 3.5],
-  [1, 1, 4.0]
-]
+data = Libmf::Matrix.new
+data.push(0, 0, 5.0)
+data.push(0, 2, 3.5)
+data.push(1, 1, 4.0)
 ```
 
 Create a model
@@ -90,7 +89,7 @@ Pass parameters - default values below
 
 ```ruby
 Libmf::Model.new(
-  loss: 0,                # loss function
+  loss: :real_l2,         # loss function
   factors: 8,             # number of latent factors
   threads: 12,            # number of threads used
   bins: 25,               # number of bins
@@ -111,21 +110,21 @@ Libmf::Model.new(
 
 For real-valued matrix factorization
 
-- 0 - squared error (L2-norm)
-- 1 - absolute error (L1-norm)
-- 2 - generalized KL-divergence
+- `:real_l2` - squared error (L2-norm)
+- `:real_l1` - absolute error (L1-norm)
+- `:real_kl` - generalized KL-divergence
 
 For binary matrix factorization
 
-- 5 - logarithmic error
-- 6 - squared hinge loss
-- 7 - hinge loss
+- `:binary_log` - logarithmic error
+- `:binary_l2` - squared hinge loss
+- `:binary_l1` - hinge loss
 
 For one-class matrix factorization
 
-- 10 - row-oriented pair-wise logarithmic loss
-- 11 - column-oriented pair-wise logarithmic loss
-- 12 - squared error (L2-norm)
+- `:one_class_row` - row-oriented pair-wise logarithmic loss
+- `:one_class_col` - column-oriented pair-wise logarithmic loss
+- `:one_class_l2` - squared error (L2-norm)
 
 ## Performance
 
@@ -159,22 +158,22 @@ model.q_factors(format: :numo)
 
 ## History
 
-View the [changelog](https://github.com/ankane/libmf/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/libmf-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/libmf/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/libmf/pulls)
+- [Report bugs](https://github.com/ankane/libmf-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/libmf-ruby/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
+git clone --recursive https://github.com/ankane/libmf-ruby.git
+cd libmf-ruby
 bundle install
 bundle exec rake vendor:all
 bundle exec rake test

data/lib/libmf/ffi.rb

@@ -43,15 +43,22 @@ module Libmf
         :b, :float,
         :p, :pointer,
         :q, :pointer
+
+      def self.release(pointer)
+        unless pointer.null?
+          ref = ::FFI::MemoryPointer.new(:pointer).write_pointer(pointer)
+          FFI.mf_destroy_model(ref)
+        end
+      end
     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
-    attach_function :mf_train, [Problem.by_ref, Parameter.by_value], Model.by_ref
-    attach_function :mf_train_with_validation, [Problem.by_ref, Problem.by_ref, Parameter.by_value], Model.by_ref
+    attach_function :mf_load_model, [:string], Model.auto_ptr
+    attach_function :mf_destroy_model, [:pointer], :void
+    attach_function :mf_train, [Problem.by_ref, Parameter.by_value], Model.auto_ptr
+    attach_function :mf_train_with_validation, [Problem.by_ref, Problem.by_ref, Parameter.by_value], Model.auto_ptr
     attach_function :mf_predict, [Model.by_ref, :int, :int], :float
     attach_function :mf_cross_validation, [Problem.by_ref, :int, Parameter.by_value], :double
   end

data/lib/libmf/matrix.rb

@@ -0,0 +1,13 @@
+module Libmf
+  class Matrix
+    attr_reader :data
+
+    def initialize
+      @data = []
+    end
+
+    def push(row_index, column_index, value)
+      @data << [row_index, column_index, value]
+    end
+  end
+end

data/lib/libmf/model.rb

@@ -14,6 +14,7 @@ module Libmf
         else
           FFI.mf_train(train_set, param)
         end
+      raise Error, "fit failed" if @model.null?
 
       nil
     end
@@ -24,15 +25,20 @@ module Libmf
 
     def cv(data, folds: 5)
       problem = create_problem(data)
-      FFI.mf_cross_validation(problem, folds, param)
+      # TODO update fork to differentiate between bad parameters and zero error
+      res = FFI.mf_cross_validation(problem, folds, param)
+      raise Error, "cv failed" if res == 0
+      res
     end
 
     def save_model(path)
-      FFI.mf_save_model(model, path)
+      status = FFI.mf_save_model(model, path)
+      raise Error, "Cannot save model" if status != 0
     end
 
     def load_model(path)
       @model = FFI.mf_load_model(path)
+      raise Error, "Cannot open model" if @model.null?
     end
 
     def rows
@@ -80,6 +86,22 @@ module Libmf
     def param
       param = FFI.mf_get_default_param
       options = @options.dup
+
+      if options[:loss].is_a?(Symbol)
+        loss_map = {
+          real_l2: 0,
+          real_l1: 1,
+          real_kl: 2,
+          binary_log: 5,
+          binary_l2: 6,
+          binary_l1: 7,
+          one_class_row: 10,
+          one_class_col: 11,
+          one_class_l2: 12
+        }
+        options[:loss] = loss_map[options[:loss]] || (raise ArgumentError, "Unknown loss")
+      end
+
       # silence insufficient blocks warning with default params
       options[:bins] ||= 25 unless options[:nr_bins]
       options[:copy_data] = false unless options.key?(:copy_data)
@@ -107,6 +129,10 @@ module Libmf
         return FFI.mf_read_problem(File.expand_path(data))
       end
 
+      if data.is_a?(Matrix)
+        data = data.data
+      end
+
       raise Error, "No data" if data.empty?
 
       # TODO do in C for better performance

data/lib/libmf/version.rb

@@ -1,3 +1,3 @@
 module Libmf
-  VERSION = "0.2.2"
+  VERSION = "0.2.6"
 end

data/lib/libmf.rb

@@ -2,6 +2,7 @@
 require "ffi"
 
 # modules
+require "libmf/matrix"
 require "libmf/model"
 require "libmf/version"
 
@@ -15,13 +16,17 @@ module Libmf
     if Gem.win_platform?
       "mf.dll"
     elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
-      if RbConfig::CONFIG["host_cpu"] =~ /arm/i
+      if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
         "libmf.arm64.dylib"
       else
         "libmf.dylib"
       end
     else
-      "libmf.so"
+      if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+        "libmf.arm64.so"
+      else
+        "libmf.so"
+      end
     end
   vendor_lib = File.expand_path("../vendor/#{lib_name}", __dir__)
   self.ffi_lib = [vendor_lib]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libmf
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -35,16 +35,18 @@ files:
 - README.md
 - lib/libmf.rb
 - lib/libmf/ffi.rb
+- lib/libmf/matrix.rb
 - lib/libmf/model.rb
 - lib/libmf/version.rb
 - vendor/COPYRIGHT
 - vendor/demo/real_matrix.te.txt
 - vendor/demo/real_matrix.tr.txt
 - vendor/libmf.arm64.dylib
+- vendor/libmf.arm64.so
 - vendor/libmf.dylib
 - vendor/libmf.so
 - vendor/mf.dll
-homepage: https://github.com/ankane/libmf
+homepage: https://github.com/ankane/libmf-ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -63,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Large-scale sparse matrix factorization for Ruby