@@ -44,7 +44,7 @@ Install the package with:
4444``` bash
4545pip 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
4949pip 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