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

Update documentation to reflect k-NN FAISS AVX512 support #8307

Merged
merged 7 commits into from
Sep 30, 2024

Conversation

noahstaveley
Copy link
Contributor

@noahstaveley noahstaveley commented Sep 17, 2024

Description

This change updates the documentation to reflect AVX512 hardware accelerator support that was added to speed up vector search and indexing. The k-NN index and settings pages under k-NN search are updated in this change.

Issues Resolved

Closes #8306

Version

2.18

Related to the PR: opensearch-project/k-NN#2110

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

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.

@noahstaveley
Copy link
Contributor Author

@akashsha1

@akashsha1
Copy link
Contributor

@naveentatikonda - public documentation for AVX512 PR

_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
@kolchfa-aws
Copy link
Collaborator

@noahstaveley Could you please resolve DCO? Also, is this for versions 2.16 and above or for the next version (2.18)?

@naveentatikonda
Copy link
Member

@akashsha1 @noahstaveley I will try to review this PR by EOD. Thanks!

@noahstaveley
Copy link
Contributor Author

@noahstaveley Could you please resolve DCO? Also, is this for versions 2.16 and above or for the next version (2.18)?

DCO is resolved. This is for version 2.18 only, I updated the PR to reflect that. Thanks for confirming

@naveentatikonda
Copy link
Member

@noahstaveley Why are we seeing so many commits included in this PR. Can you rebase this PR again ?

@noahstaveley
Copy link
Contributor Author

@noahstaveley Why are we seeing so many commits included in this PR. Can you rebase this PR again ?

@naveentatikonda Yes sorry about that, I rebased and removed the unrelated commits.

_search-plugins/knn/knn-index.md Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
@naveentatikonda
Copy link
Member

@noahstaveley Thanks for raising this PR. @kolchfa-aws can you please review it. Thanks!

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @noahstaveley! Some suggestions for you. Once addressed, I'll move the PR to editorial review.

_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws added 4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes labels Sep 26, 2024
@kolchfa-aws kolchfa-aws added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Sep 26, 2024
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.

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

_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/knn-index.md Outdated Show resolved Hide resolved
_search-plugins/knn/settings.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws merged commit 1867a65 into opensearch-project:main Sep 30, 2024
5 checks passed
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 9, 2024
…-project#8307)

* AVX512 updates

Signed-off-by: Noah Staveley <[email protected]>

* updatedwith correct version for AVX512 release

Signed-off-by: Noah Staveley <[email protected]>

* change to reflect avx512/avx2 preference order

Signed-off-by: Noah Staveley <[email protected]>

* change to knn-index. specified order of performance

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/settings.md and knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

---------

Signed-off-by: Noah Staveley <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: [email protected] <[email protected]>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 9, 2024
…-project#8307)

* AVX512 updates

Signed-off-by: Noah Staveley <[email protected]>

* updatedwith correct version for AVX512 release

Signed-off-by: Noah Staveley <[email protected]>

* change to reflect avx512/avx2 preference order

Signed-off-by: Noah Staveley <[email protected]>

* change to knn-index. specified order of performance

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/settings.md and knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

---------

Signed-off-by: Noah Staveley <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: [email protected] <[email protected]>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
…-project#8307)

* AVX512 updates

Signed-off-by: Noah Staveley <[email protected]>

* updatedwith correct version for AVX512 release

Signed-off-by: Noah Staveley <[email protected]>

* change to reflect avx512/avx2 preference order

Signed-off-by: Noah Staveley <[email protected]>

* change to knn-index. specified order of performance

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

* Update _search-plugins/knn/settings.md and knn-index.md

Signed-off-by: Noah Staveley <[email protected]>

---------

Signed-off-by: Noah Staveley <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update k-NN plugin documentation to reflect AVX512 SIMD optimization update
5 participants