Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct k-NN settings and add more #7693

Merged
merged 4 commits into from
Jul 15, 2024
Merged

Correct k-NN settings and add more #7693

merged 4 commits into from
Jul 15, 2024

Conversation

kolchfa-aws
Copy link
Collaborator

Closes #7642

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Member

@jmazanec15 jmazanec15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
`knn.faiss.avx2.disabled` | False | A static setting that specifies whether to disable the SIMD-based `libopensearchknn_faiss_avx2.so` library and load the non-optimized `libopensearchknn_faiss.so` library for the Faiss engine on machines with x64 architecture. For more information, see [SIMD optimization for the Faiss engine]({{site.url}}{{site.baseurl}}/search-plugins/knn/knn-index/#simd-optimization-for-the-faiss-engine).
:--- | :--- | :---
`index.knn.advanced.filtered_exact_search_threshold`| `null` | The threshold value for the filtered IDs that is used to switch to exact search during filtered ANN search. If the number of filtered IDs in a segment is less than this setting's value, exact search will be performed on the filtered IDs.
`index.knn.algo_param.ef_search` | `100` | `ef` (or `efSearch`) is the size of the dynamic list for the nearest neighbors used during the search. Higher values of `ef` lead to a more accurate but slower search. `ef` cannot be set lower than the number of queried nearest neighbors `k`. `ef` can take any value between `k` and the size of the dataset.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the "total" size of the dataset?

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolchfa-aws kolchfa-aws merged commit 3fb528c into main Jul 15, 2024
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 15, 2024
* Correct k-NN settings and add more

Signed-off-by: Fanit Kolchina <[email protected]>

* Add heading

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 3fb528c)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
* Correct k-NN settings and add more

Signed-off-by: Fanit Kolchina <[email protected]>

* Add heading

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
* Correct k-NN settings and add more

Signed-off-by: Fanit Kolchina <[email protected]>

* Add heading

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
@kolchfa-aws kolchfa-aws deleted the knn-settings branch November 21, 2024 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] knn.advanced.filtered_exact_search_threshold is mentioned as a cluster settings but it's not
3 participants