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 vectorsearch README update regarding recall accuracy #516

Merged

Conversation

IanHoang
Copy link
Collaborator

@IanHoang IanHoang commented Dec 6, 2024

Description

Currently, users are mislead by the recall value when using more search_clients than the number of CPU cores on the load generation host running the benchmark. We have already incorporated a short term fix for this opensearch-project/opensearch-benchmark#626 but would like to update the README too.

Issues Resolved

#347

Backport to Branches:

  • 6
  • 7
  • 1
  • 2
  • 3

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

@@ -36,6 +36,9 @@ opensearch-benchmark execute-test \
--pipeline benchmark-only \
--kill-running-processes
```
### Best Recall Results

For accurate recall results, we recommend users to keep `search_clients` equal to or less than the number of CPU cores on the load generation host that is running the benchmark.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The command nproc can be used on Linux or MacOS to determine the number of cores.

@IanHoang IanHoang added backport 2 Backport to the "2" branch backport 1 backport 3 Backport to the "3" branch labels Dec 6, 2024
@IanHoang IanHoang merged commit bb212c1 into opensearch-project:main Dec 6, 2024
5 checks passed
@IanHoang IanHoang deleted the update_vectorsearch_readme branch December 6, 2024 22:28
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit bb212c1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit bb212c1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit bb212c1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
(cherry picked from commit bb212c1)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
(cherry picked from commit bb212c1)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
(cherry picked from commit bb212c1)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshpalis pushed a commit to joshpalis/opensearch-benchmark-workloads that referenced this pull request Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1 backport 2 Backport to the "2" branch backport 3 Backport to the "3" branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants