updated documentation

terrierteam · Dec 19, 2024 · 17858aa · 17858aa
1 parent acdb611
commit 17858aa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/pyterrier_dr/flex/core.py b/pyterrier_dr/flex/core.py
@@ -196,7 +196,7 @@ def docnos(self) -> Lookup:
 
     @property
     def ILS(self) -> ir_measures.Measure:
-        """Return an ILS (Intra-List Similarity) measure for this index. See: :func:`pyterrier_dr.ILS` for more details."""
+        """Return an ILS (Intra-List Similarity) measure for this index. See :func:`pyterrier_dr.ILS` for more details."""
         return pyterrier_dr.ILS(self)
 
     def __repr__(self):

diff --git a/pyterrier_dr/pt_docs/indexing-retrieval.rst b/pyterrier_dr/pt_docs/indexing-retrieval.rst
@@ -59,6 +59,12 @@ API Documentation
     .. automethod:: gar
     .. automethod:: ladr_proactive
     .. automethod:: ladr_adaptive
+    .. automethod:: mmr
+
+    Evaluation
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    .. autoproperty:: ILS
 
     Index Data Access
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^