libmf 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5a2bbda585f7e2f57630d20dfb6cf6091ab33e90227edd277c457af7f8dac7
-  data.tar.gz: 3f8a1612c831223e552cf5af4172f31080d297f2e3f059624d66790613333890
+  metadata.gz: 499cc67221be5e767caa7257e69c23a2b17c537c5950e2eeebb7de21d5bec1f0
+  data.tar.gz: 9345dc3804dfc928bbdb03b588e64f20fbb3ddb5a3674b65972c122842bef60e
 SHA512:
-  metadata.gz: 6d8cf1bf142c4e365c2b01a10c5e407d331d24d8410f8ee2b262c6ca6c94dfe129c5ac0a3dc6ae97e0739884aaeec9483c39546714975a8e9929c8a63799f15c
-  data.tar.gz: 80356261c846d506160df89424b9f67d070908e1cc1f9c583e83cbbec5b7ebce272acb5146e447dd1394bb7c5d3268bf00837dc0814eb5ccb23d8c23c53efae3
+  metadata.gz: 6cd517a3e7eb418390012352a62de72aa9e3a4077b08c5d8602e89a9a8af0dcdc654a51359641e374d263804189a814afffa8e2f55db52ef7506e222e2143e5f
+  data.tar.gz: 5dad62dd22cd82499d4f0c2b2c06792945c50065a2517d89baeec8d00c62e2628d62d3702cc3964344c3e437f4281afd1f79f58291efca12f3c788e5ed07d0e1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

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/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.4"
+  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"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libmf
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/libmf.rb
 - lib/libmf/ffi.rb
+- lib/libmf/matrix.rb
 - lib/libmf/model.rb
 - lib/libmf/version.rb
 - vendor/COPYRIGHT