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 Vector Search workload to benchmark #9141

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Naarcha-AWS
Copy link
Collaborator

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.

@Naarcha-AWS Naarcha-AWS added benchmark backport 2.18 PR: Backport label for 2.18 labels Jan 30, 2025
@Naarcha-AWS Naarcha-AWS self-assigned this Jan 30, 2025
@Naarcha-AWS Naarcha-AWS added the 3 - Tech review PR: Tech review in progress label Jan 30, 2025
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.

@OVI3D0
Copy link
Member

OVI3D0 commented Jan 31, 2025

Would it help to put any info like cluster requirements (minimum OS version/necessary plugins) or is this more of a general overview of the workload?

cc: @IanHoang @gkamat

@Naarcha-AWS
Copy link
Collaborator Author

Naarcha-AWS commented Feb 3, 2025

@OVI3D0: I think cluster requirements would be a great addition. That being said, are the cluster requirements general for all workloads, or do we have specific cluster requirements/recommendations for each?

This is meant to be more of a general overview, but any additional detail/guidance we can add would be helpful.

@Naarcha-AWS
Copy link
Collaborator Author

@IanHoang and @OVI3D0: Feel free to review this when you're ready.


# Vector search

The vector Search workload benchmarks OpenSearch's Vector Engine capabilities for both indexing and search operations. It tests various vector search algorithms, quantization methods, and index configurations to measure performance metrics like throughput, latency, and recall accuracy. The workload supports different datasets and can evaluate both trained and untrained vector search methods.
Copy link
Contributor

Choose a reason for hiding this comment

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

Search -> search in the first sentence

Copy link
Contributor

@IanHoang IanHoang left a comment

Choose a reason for hiding this comment

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

This looks fine to me. We can have this merged in for now and get feedback on it from users.

As discussed in our previous meeting, this is mostly identical to the Vectorsearch README from the workloads repository. The concern is if the README evolves over time, we'll need to update this documentation accordingly. If we plan to differentiate this documentation from the workload's README, we should consider either simplifying this or making this more of an intuitive "practical" guide instead. That way, this documentation can stand on its own and we can still link the README if users need more technical support.

@Naarcha-AWS
Copy link
Collaborator Author

This looks fine to me. We can have this merged in for now and get feedback on it from users.

As discussed in our previous meeting, this is mostly identical to the Vectorsearch README from the workloads repository. The concern is if the README evolves over time, we'll need to update this documentation accordingly. If we plan to differentiate this documentation from the workload's README, we should consider either simplifying this or making this more of an intuitive "practical" guide instead. That way, this documentation can stand on its own and we can still link the README if users need more technical support.

One thing we could do is give more examples about how to/when to incorporate certain workload-params.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Tech review PR: Tech review in progress backport 2.18 PR: Backport label for 2.18 benchmark
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants