Add HPF docs

lenskit · Oct 19, 2018 · 5926ec6 · 5926ec6
1 parent cf8f8f5
commit 5926ec6
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/doc/algorithms.rst b/doc/algorithms.rst
@@ -12,3 +12,4 @@ algorithms.
    basic
    knn
    mf
+   hpf
diff --git a/doc/hpf.rst b/doc/hpf.rst
@@ -0,0 +1,16 @@
+Hierarchical Poisson Factorization
+==================================
+
+.. module:: lenskit.algorithms.hpf
+
+This module provides a LensKit bridge to the hpfrec_ library implementing hierarchical Poisson
+factorization [GHB2013]_.
+
+.. _hpfrec: https://hpfrec.readthedocs.io/en/latest/
+.. [GHB2013] Prem Gopalan, Jake M. Hofman, and David M. Blei. 2013.
+    Scalable Recommendation with Poisson Factorization.
+    arXiv:1311.1704 [cs, stat] (November 2013). Retrieved February 9, 2017
+    from `<http://arxiv.org/abs/1311.1704>`_.
+
+.. autoclass:: HPF
+    :members:
diff --git a/lenskit/algorithms/hpf.py b/lenskit/algorithms/hpf.py
@@ -12,11 +12,11 @@ class HPF(Predictor, Trainable):
     """
     Hierarchical Poisson factorization, provided by hpfrec_.
 
-    .. _hpfrec:: https://hpfrec.readthedocs.io/en/latest/
+    .. _hpfrec: https://hpfrec.readthedocs.io/en/latest/
 
     Args:
         features(int): the number of features
-        **kwargs: arguments passed to hpfrec.HPF.
+        **kwargs: arguments passed to :py:class:`hpfrec.HPF`.
     """
 
     def __init__(self, features, **kwargs):