Skip to content

Commit

Permalink
: in directives mean something else, changed to .
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmacavaney committed Dec 3, 2024
1 parent a44823a commit e537a64
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions pyterrier_dr/flex/faiss_retr.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def _faiss_flat_retriever(self, *, gpu=False, qbatch=64, drop_query_vec=False):
.. note::
This transformer requires the ``faiss`` package to be installed.
.. cite:dblp:: journals/corr/abs-2401-08281
.. cite.dblp:: journals/corr/abs-2401-08281
"""
pyterrier_dr.util.assert_faiss()
import faiss
Expand Down Expand Up @@ -135,7 +135,7 @@ def _faiss_hnsw_retriever(
.. note::
This transformer requires the ``faiss`` package to be installed.
.. cite:dblp:: journals/corr/abs-2401-08281
.. cite.dblp:: journals/corr/abs-2401-08281
"""
pyterrier_dr.util.assert_faiss()
import faiss
Expand Down Expand Up @@ -177,7 +177,7 @@ def _faiss_hnsw_graph(self, neighbours: int = 32, *, ef_construction: int = 40):
.. note::
This function requires the ``faiss`` package to be installed.
.. cite:dblp:: journals/corr/abs-2401-08281
.. cite.dblp:: journals/corr/abs-2401-08281
"""
key = ('faiss_hnsw', neighbours//2, ef_construction)
graph_name = f'hnsw_n-{neighbours}_ef-{ef_construction}.graph'
Expand Down Expand Up @@ -248,7 +248,7 @@ def _faiss_ivf_retriever(self,
.. note::
This transformer requires the ``faiss`` package to be installed.
.. cite:dblp:: journals/corr/abs-2401-08281
.. cite.dblp:: journals/corr/abs-2401-08281
"""
pyterrier_dr.util.assert_faiss()
import faiss
Expand Down
2 changes: 1 addition & 1 deletion pyterrier_dr/flex/gar.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ def _gar(self,
Returns:
:class:`~pyterrier.Transformer`: A retriever that uses a corpus graph to search over a FlexIndex.
.. cite:dblp:: conf/cikm/MacAvaneyTM22
.. cite.dblp:: conf/cikm/MacAvaneyTM22
"""
return FlexGar(self, self.corpus_graph(k), SimFn.dot, batch_size=batch_size, num_results=num_results)
FlexIndex.gar = _gar
4 changes: 2 additions & 2 deletions pyterrier_dr/flex/ladr.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def _pre_ladr(self,
Returns:
:class:`~pyterrier.Transformer`: A proactive LADR transformer.
.. cite:dblp:: conf/sigir/KulkarniMGF23
.. cite.dblp:: conf/sigir/KulkarniMGF23
"""
graph = self.corpus_graph(k) if isinstance(k, int) else k
return LadrPreemptive(self, graph, num_results=num_results, hops=hops, dense_scorer=dense_scorer or self.scorer(), drop_query_vec=drop_query_vec)
Expand Down Expand Up @@ -162,7 +162,7 @@ def _ada_ladr(self,
Returns:
:class:`~pyterrier.Transformer`: An adaptive LADR transformer.
.. cite:dblp:: conf/sigir/KulkarniMGF23
.. cite.dblp:: conf/sigir/KulkarniMGF23
"""
graph = self.corpus_graph(k) if isinstance(k, int) else k
return LadrAdaptive(self, graph, num_results=num_results, dense_scorer=dense_scorer or self.scorer(), depth=depth, max_hops=max_hops, drop_query_vec=drop_query_vec)
Expand Down
2 changes: 1 addition & 1 deletion pyterrier_dr/flex/scann_retr.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def _scann_retriever(self,
.. note::
This method requires the ``scann`` package. Install it via ``pip install scann``.
.. cite:dblp:: conf/icml/GuoSLGSCK20
.. cite.dblp:: conf/icml/GuoSLGSCK20
"""
pyterrier_dr.util.assert_scann()
import scann
Expand Down
4 changes: 2 additions & 2 deletions pyterrier_dr/prf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class VectorPrf(pt.Transformer):
prf_pipe = model >> index >> index.vec_loader() >> pyterier_dr.vector_prf() >> index
.. cite:dblp:: journals/tois/0009MZKZ23
.. cite.dblp:: journals/tois/0009MZKZ23
"""
def __init__(self,
*,
Expand Down Expand Up @@ -68,7 +68,7 @@ class AveragePrf(pt.Transformer):
prf_pipe = model >> index >> index.vec_loader() >> pyterier_dr.average_prf() >> index
.. cite:dblp:: journals/tois/0009MZKZ23
.. cite.dblp:: journals/tois/0009MZKZ23
"""
def __init__(self,
*,
Expand Down

0 comments on commit e537a64

Please sign in to comment.