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

Added documentation for changing the default values of HNSW hyper parameters in k-NN plugin #6272

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

navneet1v
Copy link
Contributor

@navneet1v navneet1v commented Jan 29, 2024

Description

Added documentation for changing the default values of HNSW hyper parameters in k-NN plugin

Issues Resolved

Resolves #6021

k-NN plugin issue: opensearch-project/k-NN#1354

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.

@hdhalter
Copy link
Contributor

Thanks, @navneet1v ! Is this PR ready for doc review?

@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes v2.12.0 labels Jan 29, 2024
@navneet1v
Copy link
Contributor Author

@hdhalter yes it is.

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, @navneet1v! A couple of rewrites.

_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
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/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/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/knn-index.md Outdated Show resolved Hide resolved
@navneet1v
Copy link
Contributor Author

@natebower I fixed all your comments. Please review.

@natebower natebower added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 31, 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.

@navneet1v @kolchfa-aws Just one change. Otherwise, LGTM.

@kolchfa-aws kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels Jan 31, 2024
@kolchfa-aws
Copy link
Collaborator

@navneet1v Thank you! This PR is ready; we'll merge it closer to the release.

navneet1v and others added 2 commits January 31, 2024 22:50
…meters in k-NN plugin

Signed-off-by: Navneet Verma <navneev@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@hdhalter hdhalter merged commit 4b3f09a into opensearch-project:main Feb 1, 2024
3 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update the k-NN documentation to reflect the new Default values for K-NN engine hyper parameters
4 participants