libmf 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7744d5436815acc2609c8c39566f5704513248b5fe0b7ddc1cc4fbd28c81e9
-  data.tar.gz: 0bcd219cc9360b0e9daefe418e2a14fc46969ab174db5ea93717c837e309c697
+  metadata.gz: 499cc67221be5e767caa7257e69c23a2b17c537c5950e2eeebb7de21d5bec1f0
+  data.tar.gz: 9345dc3804dfc928bbdb03b588e64f20fbb3ddb5a3674b65972c122842bef60e
 SHA512:
-  metadata.gz: 49d31c33bea909e1a3a0a8cdebc6cce76b2cf19debc11420d76ad2016763961f376df56bdbba16e6a60e72a8014a2b44547045b2385f44b6c96f48f3f6148643
-  data.tar.gz: 3f264d87a4cc727634ac8b2cb5dc87a56a44c3fba7d77093c83ca3623437be6024c04b1fe154275fd3a14a6736bf6703ea2fae9b984570b5c4629af3b5c710f3
+  metadata.gz: 6cd517a3e7eb418390012352a62de72aa9e3a4077b08c5d8602e89a9a8af0dcdc654a51359641e374d263804189a814afffa8e2f55db52ef7506e222e2143e5f
+  data.tar.gz: 5dad62dd22cd82499d4f0c2b2c06792945c50065a2517d89baeec8d00c62e2628d62d3702cc3964344c3e437f4281afd1f79f58291efca12f3c788e5ed07d0e1

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 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
+- Improved ARM detection
+
 ## 0.2.1 (2020-12-28)
 
 - Added ARM shared library for Mac

data/LICENSE.txt

@@ -1,7 +1,7 @@
 BSD 3-Clause License
 
 Copyright (c) 2014-2015, The LIBMF Project
-Copyright (c) 2019-2020, Andrew Kane
+Copyright (c) 2019-2021, Andrew Kane
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -90,7 +90,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 +111,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
 

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,14 +129,19 @@ 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
       # can use FIX2INT() and RFLOAT_VALUE() instead of pack
+      # and write directly to C string
       buffer = String.new
+      pack_format = "iif"
       data.each do |row|
-        row[0, 2].pack("i*".freeze, buffer: buffer)
-        row[2, 1].pack("f".freeze, buffer: buffer)
+        row.pack(pack_format, buffer: buffer)
       end
 
       r = ::FFI::MemoryPointer.new(FFI::Node, data.size)

data/lib/libmf/version.rb

@@ -1,3 +1,3 @@
 module Libmf
-  VERSION = "0.2.1"
+  VERSION = "0.2.5"
 end

data/lib/libmf.rb

@@ -2,6 +2,7 @@
 require "ffi"
 
 # modules
+require "libmf/matrix"
 require "libmf/model"
 require "libmf/version"
 
@@ -14,12 +15,18 @@ module Libmf
   lib_name =
     if Gem.win_platform?
       "mf.dll"
-    elsif RbConfig::CONFIG["arch"] =~ /arm64-darwin/i
-      "libmf.arm64.dylib"
     elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
-      "libmf.dylib"
+      if RbConfig::CONFIG["host_cpu"] =~ /arm/i
+        "libmf.arm64.dylib"
+      else
+        "libmf.dylib"
+      end
     else
-      "libmf.so"
+      if RbConfig::CONFIG["host_cpu"] =~ /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.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description:
-email: andrew@chartkick.com
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,12 +35,14 @@ 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
@@ -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.22
 signing_key:
 specification_version: 4
 summary: Large-scale sparse matrix factorization for Ruby