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

Improve cuvs-bench doc and add executable dir option #681

Open
wants to merge 4 commits into
base: branch-25.04
Choose a base branch
from

Conversation

tfeher
Copy link
Contributor

@tfeher tfeher commented Feb 12, 2025

Fixes the first two points in #679

@tfeher tfeher requested review from a team as code owners February 12, 2025 13:11
@tfeher tfeher added doc Improvements or additions to documentation improvement Improves an existing functionality non-breaking Introduces a non-breaking change and removed doc Improvements or additions to documentation labels Feb 12, 2025
Testing on new datasets
-----------------------

To run benchmark on a dataset, it is required have a descriptor that defines the file names and a few other properties of that datase.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To run benchmark on a dataset, it is required have a descriptor that defines the file names and a few other properties of that datase.
To run benchmark on a dataset, it is required have a descriptor that defines the file names and a few other properties of that dataset.

show_default=True,
prompt="Enter the name of the folder that contains the executables",
help="Path to executable folder, by default we will look in "
"$CUVS_HOME/cpp/build/release and $CONDA_PREFIX/bin/ann.",
Copy link
Member

Choose a reason for hiding this comment

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

Is it build/release or just build? Also do we look in build first then conda prefix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants