Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdekstrand committed Aug 22, 2022
1 parent 069d52b commit d50e9fa
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 22 deletions.
22 changes: 22 additions & 0 deletions docs/biased-mf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Biased MF
=========

These models implement the standard biased matrix factorization model, like
:py:class:`lenskit.algorithms.als.BiasedMF`, but learn the model parameters
using TensorFlow's gradient descent instead of the alternating least squares
algorithm. There are two implementations:

* :py:class:`lenskit_tf.BiasedMF` learns a matrix factorization to predict the
residuals of :py:class:`lenskit.algorithms.bias.Bias`.
* :py:class:`lenskit_tf.IntegratedBiasMF` uses TensorFlow to learn the entire
model, including both biases and embeddings.

Bias-Based
~~~~~~~~~~

.. autoclass:: lenskit_tf.BiasedMF

Fully Integrated
~~~~~~~~~~~~~~~~

.. autoclass:: lenskit_tf.IntegratedBiasMF
6 changes: 6 additions & 0 deletions docs/bpr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Bayesian Personalized Ranking
=============================

This is a TensorFlow-based implementation of BPR.

.. autoclass:: BPR
24 changes: 2 additions & 22 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,25 +28,5 @@ Or (preferred, once published)::
.. toctree::
:caption: Contents

Biased MF
---------

These models implement the standard biased matrix factorization model, like
:py:class:`lenskit.algorithms.als.BiasedMF`, but learn the model parameters
using TensorFlow's gradient descent instead of the alternating least squares
algorithm.

Bias-Based
~~~~~~~~~~

.. autoclass:: BiasedMF

Fully Integrated
~~~~~~~~~~~~~~~~

.. autoclass:: IntegratedBiasMF

Bayesian Personalized Rating
----------------------------

.. autoclass:: BPR
biased-mf
bpr

0 comments on commit d50e9fa

Please sign in to comment.