Mark nmslib references for vector search as deprecated #9107
Conversation
Signed-off-by: Kunal Kotwani <[email protected]>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kotwanikunal
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
There was a problem hiding this comment.
Thank you, @kotwanikunal! A couple of styling suggestions. Also, should we remove some of the mentions of NMSLIB in the text and just keep it in the tables?
kolchfa-aws
added
release-notes
Signed-off-by: kolchfa-aws <[email protected]>
There was a problem hiding this comment.
@kolchfa-aws @kotwanikunal Please see my comments and changes and let me know if you have any questions. Thanks!
_search-plugins/knn/api.md
Outdated
| @@ -173,11 +173,11 @@ For the warmup operation to function properly, follow these best practices: | |||
| Introduced 2.14 | |||
| {: .label .label-purple } | |||
|
|
|||
| During approximate k-NN search or warmup operations, the native library indexes (`nmslib` and `faiss` engines) are loaded into native memory. Currently, you can evict an index from cache or native memory by either deleting the index or setting the k-NN cluster settings `knn.cache.item.expiry.enabled` and `knn.cache.item.expiry.minutes`, which removes the index from the cache if it is idle for a given period of time. However, you cannot evict an index from the cache without deleting the index. To solve this problem, you can use the k-NN clear cache API operation, which clears a given set of indexes from the cache. | |||
| During approximate k-NN search or warmup operations, the native library indexes (for the `faiss` and `nmslib` [deprecated] engines) are loaded into native memory. Currently, you can evict an index from cache or native memory by either deleting the index or setting the k-NN cluster settings `knn.cache.item.expiry.enabled` and `knn.cache.item.expiry.minutes`, which removes the index from the cache if it is idle for a given period of time. However, you cannot evict an index from the cache without deleting the index. To solve this problem, you can use the k-NN clear cache API operation, which clears a given set of indexes from the cache. | |||
There was a problem hiding this comment.
2nd sentence: Should "the" precede the first instance of "cache"?
| @@ -92,7 +92,7 @@ Mapping parameter | Required | Default | Updatable | Description | |||
| :--- | :--- | :--- | :--- | :--- | |||
| `name` | true | n/a | false | The identifier for the nearest neighbor method. | |||
| `space_type` | false | l2 | false | The vector space used to calculate the distance between vectors. Note: This value can also be specified at the top level of the mapping. | |||
| `engine` | false | faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are `faiss`, `nmslib`, and `lucene`. | |||
| `engine` | false | faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are `faiss`, `lucene`, and `nmslib` (deprecated). | |||
There was a problem hiding this comment.
In the third column, should "faiss" be either "Faiss" or faiss?
There was a problem hiding this comment.
Yes, but I'll address it as part of a complete revamp of the vector search section. Otherwise, we'd need to change the whole column.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
added
the
6 - Done but waiting to merge
I think we should keep the text with the deprecated notices for now. |
kolchfa-aws
removed
the
6 - Done but waiting to merge
Description
Issues Resolved
N/A
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.