Skip to content

Commit 71a9c29

Browse files
authored
docs: Updated backend docs (#45)
* Updated names * Updated precommit install * Updated names
1 parent aeaccaa commit 71a9c29

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ install: venv
99
uv run pre-commit install
1010

1111
install-no-pre-commit:
12-
uv pip install ".[dev,hnsw,pynndescent,annoy,faiss,usearch,voyager]"
12+
uv pip install ".[dev,all]"
1313

1414
install-base:
1515
uv sync --extra dev

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Install the package with:
4444
```bash
4545
pip install vicinity
4646
```
47-
Optinally, [install any of the supported backends](#installation), or simply install all of them with:
47+
Optionally, [install any of the supported backends](#installation), or simply install all of them with:
4848
```bash
4949
pip install vicinity[all]
5050
```
@@ -131,7 +131,7 @@ NOTE: the ANN backends do not support dynamic deletion. To delete items, you nee
131131

132132
| Backend | Parameter | Description | Default Value |
133133
|-----------------|---------------------|-----------------------------------------------------------------------------------------------|---------------------|
134-
| **Annoy** | `metric` | Similarity metric to use (`dot`, `euclidean`, `cosine`). | `"cosine"` |
134+
| **ANNOY** | `metric` | Similarity metric to use (`dot`, `euclidean`, `cosine`). | `"cosine"` |
135135
| | `trees` | Number of trees to use for indexing. | `100` |
136136
| | `length` | Optional length of the dataset. | `None` |
137137
| **FAISS** | `metric` | Similarity metric to use (`cosine`, `l2`). | `"cosine"` |
@@ -143,9 +143,9 @@ NOTE: the ANN backends do not support dynamic deletion. To delete items, you nee
143143
| **HNSW** | `metric` | Similarity space to use (`cosine`, `l2`). | `"cosine"` |
144144
| | `ef_construction` | Size of the dynamic list during index construction. | `200` |
145145
| | `m` | Number of connections per layer. | `16` |
146-
| **PyNNDescent** | `metric` | Similarity metric to use (`cosine`, `euclidean`, `manhattan`). | `"cosine"` |
146+
| **PYNNDESCENT** | `metric` | Similarity metric to use (`cosine`, `euclidean`, `manhattan`). | `"cosine"` |
147147
| | `n_neighbors` | Number of neighbors to use for search. | `15` |
148-
| **Usearch** | `metric` | Similarity metric to use (`cos`, `ip`, `l2sq`, `hamming`, `tanimoto`). | `"cos"` |
148+
| **USEARCH** | `metric` | Similarity metric to use (`cos`, `ip`, `l2sq`, `hamming`, `tanimoto`). | `"cos"` |
149149
| | `connectivity` | Number of connections per node in the graph. | `16` |
150150
| | `expansion_add` | Number of candidates considered during graph construction. | `128` |
151151
| | `expansion_search` | Number of candidates considered during search. | `64` |

0 commit comments

Comments
 (0)