Add examples (#102)

* Let the evaluator accept CSR matrix for
`per_user_recommendable_items`.

* test for neumf datamanager

* Add neumf type evaluation example

Author: tohtsky

.github/workflows/run-test.yml

@@ -20,7 +20,7 @@ jobs:
           CXXFLAGS="-O0 -g -coverage" pip install -e .
       - name: Run pytest
         run: |
-          pip install pytest pytest-cov
+          pip install pytest pytest-mock pytest-cov
           pip install lightfm jaxlib jax dm-haiku optax
           pytest --cov=./irspack tests/
       - name: Generate coverage (ubuntu)

.github/workflows/wheels.yml

@@ -35,7 +35,7 @@ jobs:
       CIBW_SKIP: "${{ matrix.cibw.skip || '' }}"
       CIBW_ENVIRONMENT: "${{ matrix.cibw.env || '' }}"
       CIBW_TEST_COMMAND: pytest {project}/tests
-      CIBW_TEST_REQUIRES: pytest
+      CIBW_TEST_REQUIRES: pytest pytest-mock
       CIBW_MANYLINUX_X86_64_IMAGE: "${{ matrix.cibw.manylinux_image }}"
       CIBW_MANYLINUX_I686_IMAGE: "${{ matrix.cibw.manylinux_image }}"
       CIBW_MANYLINUX_AARCH64_IMAGE: "${{ matrix.cibw.manylinux_image }}"

Readme.md

@@ -1,4 +1,4 @@
-# irspack - Implicit recommender systems for practitioners.
+# irspack - Implicit recommender systems for practitioners
 
 [![Python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)](https://www.python.org)
 [![pypi](https://img.shields.io/pypi/v/irspack.svg)](https://pypi.python.org/pypi/irspack)

docs/source/api_reference.rst

@@ -118,3 +118,16 @@ Utilities
 
     ItemIDMapper
     IDMapper
+
+.. currentmodule:: irspack.dataset
+
+Dataset
+-------
+
+.. autosummary::
+    :toctree: api_reference
+    :nosignatures:
+
+    MovieLens1MDataManager
+    MovieLens100KDataManager
+    MovieLens20MDataManager