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

Add doc on disk-based vector search #8332

Merged
merged 8 commits into from
Sep 20, 2024

Conversation

jmazanec15
Copy link
Member

Description

Adds a doc on disk-based vector search.

Issues Resolved

Augments docs for #8075

Version

2.17 and beyond

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

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.

@ryanbogan
Copy link
Member

Can we add an example for training a model with mode and compression?

Signed-off-by: John Mazanec <[email protected]>
@jmazanec15
Copy link
Member Author

@ryanbogan added thanks

_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
Signed-off-by: John Mazanec <[email protected]>
Copy link
Member

@ryanbogan ryanbogan 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 added backport 2.17 Backport for version 2.17 v2.17.0 labels Sep 18, 2024
@jmazanec15
Copy link
Member Author

@kolchfa-aws ready for review

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[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.

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

_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
_search-plugins/knn/disk-based-vector-search.md Outdated Show resolved Hide resolved
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.

LGTM. Thank you, @jmazanec15!

@kolchfa-aws kolchfa-aws merged commit 8275be3 into opensearch-project:main Sep 20, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 20, 2024
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

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

* Typo

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

* Another typo

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: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 8275be3)
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 Sep 23, 2024
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

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

* Typo

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

* Another typo

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: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
noahstaveley pushed a commit to noahstaveley/documentation-website that referenced this pull request Sep 23, 2024
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

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

* Typo

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

* Another typo

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: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
noahstaveley pushed a commit to noahstaveley/documentation-website that referenced this pull request Sep 23, 2024
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

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

* Typo

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

* Another typo

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: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

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

* Typo

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

* Another typo

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: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.17 Backport for version 2.17 v2.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants