document installation

lenskit · Oct 22, 2021 · bd3f84b · bd3f84b
1 parent 2762ebb
commit bd3f84b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,14 @@ Hierarchical Poisson Factorization
 This module provides a LensKit bridge to the hpfrec_ library implementing hierarchical Poisson
 factorization :cite:p:`Gopalan2013-ko`.
 
+To install (after we have cut a release), run::
+    
+    pip install lenskit-hpf
+
+We do **not** provide a Conda package, because hpfrec_ is not packaged for Conda.  You can
+use ``pip`` to install this package in your Anaconda environment after installing LensKit
+itself with ``conda``.
+
 .. _hpfrec: https://hpfrec.readthedocs.io/en/latest/
 
 .. autoclass:: HPF