diff --git a/pyterrier_dr/flex/flatnav_retr.py b/pyterrier_dr/flex/flatnav_retr.py index cdc8ecc..a16441f 100644 --- a/pyterrier_dr/flex/flatnav_retr.py +++ b/pyterrier_dr/flex/flatnav_retr.py @@ -83,6 +83,10 @@ def _flatnav_retriever(self, drop_query_vec (bool): whether to drop the query_vec column after retrieval verbose (bool): whether to show progress bars + .. note:: + This transformer requires the ``flatnav`` package to be installed. Instructions are available + in the `flatnav repository `__. + .. cite:: arxiv:2412.01940 :citation: Munyampirwa et al. Down with the Hierarchy: The 'H' in HNSW Stands for "Hubs". arXiv 2024. :link: https://arxiv.org/abs/2412.01940 diff --git a/pyterrier_dr/pt_docs/indexing-retrieval.rst b/pyterrier_dr/pt_docs/indexing-retrieval.rst index a9e29fe..13f2286 100644 --- a/pyterrier_dr/pt_docs/indexing-retrieval.rst +++ b/pyterrier_dr/pt_docs/indexing-retrieval.rst @@ -37,6 +37,7 @@ API Documentation .. automethod:: faiss_flat_retriever .. automethod:: faiss_hnsw_retriever .. automethod:: faiss_ivf_retriever + .. automethod:: flatnav_retriever .. automethod:: scann_retriever .. automethod:: voyager_retriever @@ -44,7 +45,7 @@ API Documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Results can be re-ranked using indexed vectors using :meth:`scorer`. (:meth:`np_scorer` and :meth:`torch_scorer` are - available as specific implemenations, if needed.) + available as specific implementations, if needed.) :meth:`gar`, :meth:`ladr_proactive`, and :meth:`ladr_adaptive` are *adaptive* re-ranking approaches that pull in other documents from the corpus that may be relevant.