Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ jobs:
test-target: ["tests", "pylate"]

steps:
- name: Cache Hugging Face Hub
id: cache-hf
uses: actions/cache@v4
with:
path: ~/.cache/huggingface
key: ${{ runner.os }}-hf

- name: Checkout code
uses: actions/checkout@v3

Expand Down
21 changes: 10 additions & 11 deletions docs/api/indexes/Voyager.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,32 +91,31 @@ Voyager index. The Voyager index is a fast and efficient index for approximate n

**Parameters**

- **queries_embeddings** (*numpy.ndarray | torch.Tensor*)
- **k** (*int*) – defaults to `10`
- **queries_embeddings** (*numpy.ndarray | torch.Tensor*)
- **k** (*int*) – defaults to `10`

???- note "add_documents"

Add documents to the index.

**Parameters**

- **documents_ids** (*str | list[str]*)
- **documents_embeddings** (*list[numpy.ndarray | torch.Tensor]*)
- **batch_size** (*int*) – defaults to `2000`
- **documents_ids** (*str | list[str]*)
- **documents_embeddings** (*list[numpy.ndarray | torch.Tensor]*)
- **batch_size** (*int*) – defaults to `2000`

???- note "get_documents_embeddings"

Retrieve document embeddings for re-ranking from Voyager.

**Parameters**

- **document_ids** (*list[list[str]]*)
- **document_ids** (*list[list[str]]*)

???- note "remove_documents"

Remove documents from the index.

**Parameters**

- **documents_ids** (*list[str]*)

- **documents_ids** (*list[str]*)
Loading