From c7cf80c975c7913ccbd1c362f7886c6ae5dbfbf1 Mon Sep 17 00:00:00 2001 From: John Mazanec Date: Thu, 9 Jun 2022 22:06:54 -0700 Subject: [PATCH] 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 --- _search-plugins/knn/api.md | 4 ++-- _search-plugins/knn/knn-index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_search-plugins/knn/api.md b/_search-plugins/knn/api.md index ff667c48..6ed50787 100644 --- a/_search-plugins/knn/api.md +++ b/_search-plugins/knn/api.md @@ -331,7 +331,7 @@ POST /_plugins/_knn/models/{model_id}/_train?preference={node_id} "engine":"faiss", "space_type": "l2", "parameters":{ - "nlists":128, + "nlist":128, "encoder":{ "name":"pq", "parameters":{ @@ -361,7 +361,7 @@ POST /_plugins/_knn/models/_train?preference={node_id} "engine":"faiss", "space_type": "l2", "parameters":{ - "nlists":128, + "nlist":128, "encoder":{ "name":"pq", "parameters":{ diff --git a/_search-plugins/knn/knn-index.md b/_search-plugins/knn/knn-index.md index 59460d83..8fe62bc9 100644 --- a/_search-plugins/knn/knn-index.md +++ b/_search-plugins/knn/knn-index.md @@ -99,7 +99,7 @@ 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. `encoder` | false | flat | false | Encoder definition for encoding vectors. Encoders can reduce the memory footprint of your index, at the expense of search accuracy.