Skip to content

docs: fix n_dim to dim in docs #1610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoanFM merged 1 commit into from
Jun 1, 2023
Merged

docs: fix n_dim to dim in docs #1610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/user_guide/storing/docindex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ You can work around this problem by subclassing the predefined Document and addi


class MyDoc(TextDoc):
embedding: AnyTensor = Field(n_dim=128)
embedding: AnyTensor = Field(dim=128)


db = HnswDocumentIndex[MyDoc](work_dir='test_db3')
Expand Down Expand Up @@ -724,4 +724,4 @@ root_docs, sub_docs, scores = doc_index.find_subindex(
```

!!! note "Subindex not supported with InMemoryExactNNIndex"
Currently, subindex feature is not available for InMemoryExactNNIndex
Currently, subindex feature is not available for InMemoryExactNNIndex