Skip to content

Commit

Permalink
fix some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjleo committed Dec 13, 2024
1 parent 29dc4c3 commit 890a327
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/fast_forward/index/disk.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
class OnDiskIndex(Index):
"""Fast-Forward index that is read on-demand from disk.
Uses HDF5 via h5py under the hood. The `max_indexing_size` works around a
Uses HDF5 via h5py under the hood. The `max_indexing_size` argument works around a
[h5py limitation](https://docs.h5py.org/en/latest/high/dataset.html#fancy-indexing).
"""

Expand Down
2 changes: 1 addition & 1 deletion src/fast_forward/index/memory.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def __init__(
:param quantizer: The quantizer to use.
:param mode: The ranking mode.
:param encoder_batch_size: Batch size for the query encoder.
:param init_size: Initial index size. (number of vectors), defaults to 2**14
:param init_size: Initial index size (number of vectors).
:param alloc_size: Shard size (number of vectors) allocated when index is full.
"""
self._shards = []
Expand Down
2 changes: 1 addition & 1 deletion src/fast_forward/ranking.py
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ def from_run(
"""Create a Ranking object from a TREC run.
:param run: TREC run.
:param name: Method name. Defaults to None.
:param name: Method name.
:param queries: Query IDs mapped to queries.
:param dtype: How the score should be represented in the data frame.
:return: The resulting ranking.
Expand Down

0 comments on commit 890a327

Please sign in to comment.