Skip to content

Commit

Permalink
minor update in documentation for indexing
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjleo committed Dec 13, 2024
1 parent 2b67a93 commit 961b4ec
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/fast_forward/docs/indexer.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Indexer
# Indexing

The `Indexer` class is a utility for indexing collections or adding pre-computed vectors to an index.

Expand Down
2 changes: 1 addition & 1 deletion src/fast_forward/docs/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is the implementation of [Fast-Forward indexes](https://dl.acm.org/doi/abs/
# How to...

- [create and use Fast-Forward indexes?](fast_forward/index.html)
- [index a collection?](fast_forward/util.html#indexer)
- [index a collection?](fast_forward/util.html#indexing)
- [use quantization to reduce index size?](fast_forward/quantizer.html)
- [create custom encoders?](fast_forward/encoder.html#custom-encoders)
- [read, manipulate, and save rankings?](#rankings)
Expand Down

0 comments on commit 961b4ec

Please sign in to comment.