iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change nlists to nlist k-NN plugin 

Fixes typo in ivf algorithm parameter. Correct value is nlist as appears
in
https://github.com/opensearch-project/k-NN/blob/2.0/src/main/java/org/opensearch/knn/common/KNNConstants.java.

Signed-off-by: John Mazanec <jmazane@amazon.com>
This commit is contained in:
John Mazanec 2022-06-09 22:06:54 -07:00
parent 6ebcd0fea6
commit c7cf80c975
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_search-plugins/knn/api.md
View File

@ -331,7 +331,7 @@ POST /_plugins/_knn/models/{model_id}/_train?preference={node_id}
"engine":"faiss", "engine":"faiss",
"space_type": "l2", "space_type": "l2",
"parameters":{ "parameters":{
"nlists":128, "nlist":128,
"encoder":{ "encoder":{
"name":"pq", "name":"pq",
"parameters":{ "parameters":{
@ -361,7 +361,7 @@ POST /_plugins/_knn/models/_train?preference={node_id}
"engine":"faiss", "engine":"faiss",
"space_type": "l2", "space_type": "l2",
"parameters":{ "parameters":{
"nlists":128, "nlist":128,
"encoder":{ "encoder":{
"name":"pq", "name":"pq",
"parameters":{ "parameters":{

2
_search-plugins/knn/knn-index.md
View File

@ -99,7 +99,7 @@ Paramater Name | Required | Default | Updatable | Description
Paramater Name | Required | Default | Updatable | Description Paramater Name | Required | Default | Updatable | Description
:--- | :--- | :--- | :--- | :--- :--- | :--- | :--- | :--- | :---
`nlists` | false | 4 | false | Number of buckets to partition vectors into. Higher values may lead to more accurate searches, at the expense of memory and training latency. For more information about choosing the right value, refer to [*faiss*'s documentation](https://github.com/facebookresearch/faiss/wiki/Guidelines-to-choose-an-index). `nlist` | false | 4 | false | Number of buckets to partition vectors into. Higher values may lead to more accurate searches, at the expense of memory and training latency. For more information about choosing the right value, refer to [*faiss*'s documentation](https://github.com/facebookresearch/faiss/wiki/Guidelines-to-choose-an-index).
`nprobes` | false | 1 | false | Number of buckets to search over during query. Higher values lead to more accurate but slower searches. `nprobes` | false | 1 | false | Number of buckets to search over during query. Higher values lead to more accurate but slower searches.
`encoder` | false | flat | false | Encoder definition for encoding vectors. Encoders can reduce the memory footprint of your index, at the expense of search accuracy. `encoder` | false | flat | false | Encoder definition for encoding vectors. Encoders can reduce the memory footprint of your index, at the expense of search accuracy.