libmf 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 510156ab4bccb39a99441002dd80f3540b643934294bc5724dca91987b4effba
-  data.tar.gz: 03a1f04e4679ec60cb2f1d2a96e2add0b9adba03fe5715bc4f10309ab795bcc1
+  metadata.gz: b264767ceb43c4a0407896e2bcf2373a47296e1e0580c65ec2ef08471589f661
+  data.tar.gz: addfb47cc44989620f847eac0392aef7431e596af08095ddd56ed227c4b99274
 SHA512:
-  metadata.gz: eb862c0cf91a077ba2e9a0ed3f93491297cdc9801683e3587b91125c7e0b79123d0f942aea6bf3cef42fbbb43f5e8f822758a894f25a7eedf2fd9ee7b5ea4920
-  data.tar.gz: b4d74a6b3d4160f3b1165f90496a9f93c6b59ca99e5f3cc0094f022a0807fc8a34af3d9b0edeeff463264a60c19901ceaa171c3cea944d860103208e2d26dbf2
+  metadata.gz: b22bcab875b5c2e8b7432c137f90b3ea37a8c16c3e64aa0fb4c15f824f8345a3105ca981a4ea1ea091396dcd0ce10320eab52f56e6ede75601ea2192e5bc61ac
+  data.tar.gz: 2e946522f35f77a46ab3880d74da38a0efdcaf432eabc1945d35af344d5cafb2c7712a3e0660352f8cf84fbd44af5c9c4e1cc6110ef5b908cd66c3393e124a99

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0 (2024-10-22)
+
+- Dropped support for Ruby < 3.1
+
 ## 0.3.0 (2022-08-07)
 
 - Added metrics

data/LICENSE.txt

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

data/README.md

@@ -4,7 +4,7 @@
 
 Check out [Disco](https://github.com/ankane/disco) for higher-level collaborative filtering
 
-[![Build Status](https://github.com/ankane/libmf-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/libmf-ruby/actions)
+[![Build Status](https://github.com/ankane/libmf-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/libmf-ruby/actions)
 
 ## Installation
 
@@ -170,6 +170,27 @@ Calculate AUC (for one-class MF)
 model.auc(data, transpose)
 ```
 
+## Example
+
+Download the [MovieLens 100K dataset](https://grouplens.org/datasets/movielens/100k/) and use:
+
+```ruby
+require "csv"
+
+train_set = Libmf::Matrix.new
+valid_set = Libmf::Matrix.new
+
+CSV.foreach("u.data", col_sep: "\t").with_index do |row, i|
+  data = i < 80000 ? train_set : valid_set
+  data.push(row[0].to_i, row[1].to_i, row[2].to_f)
+end
+
+model = Libmf::Model.new(factors: 20)
+model.fit(train_set, eval_set: valid_set)
+
+puts model.rmse(valid_set)
+```
+
 ## Performance
 
 For performance, read data directly from files

data/lib/libmf/model.rb

@@ -141,13 +141,13 @@ module Libmf
       options[:bins] ||= 25 unless options[:nr_bins]
       options[:copy_data] = false unless options.key?(:copy_data)
       options_map = {
-        :loss => :fun,
-        :factors => :k,
-        :threads => :nr_threads,
-        :bins => :nr_bins,
-        :iterations => :nr_iters,
-        :learning_rate => :eta,
-        :nmf => :do_nmf
+        loss: :fun,
+        factors: :k,
+        threads: :nr_threads,
+        bins: :nr_bins,
+        iterations: :nr_iters,
+        learning_rate: :eta,
+        nmf: :do_nmf
       }
       options.each do |k, v|
         k = options_map[k] if options_map[k]

data/lib/libmf/version.rb

@@ -1,3 +1,3 @@
 module Libmf
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/libmf.rb

@@ -2,9 +2,9 @@
 require "ffi"
 
 # modules
-require "libmf/matrix"
-require "libmf/model"
-require "libmf/version"
+require_relative "libmf/matrix"
+require_relative "libmf/model"
+require_relative "libmf/version"
 
 module Libmf
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libmf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -58,14 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Large-scale sparse matrix factorization for Ruby