Documentation for raft ANN benchmark containers. #1833
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dantegd
added
improvement
dantegd
changed the title
cjnolet
reviewed
Sep 25, 2023
| @@ -36,7 +36,9 @@ def positive_int(input_str: str) -> int: | |||
|
|
|||
| def validate_algorithm(algos_conf, algo, gpu_present): | |||
| algos_conf_keys = set(algos_conf.keys()) | |||
| print("algo", algo) | |||
There was a problem hiding this comment.
Should these be removed? I'm on board w/ printing something when a specific algorithm is being asked for but it can't be executed (such as when a gpu algorithm is being requested in cpu-only).
docs/source/raft_ann_benchmarks.md
Outdated
|
|
||
| **Note:** The user inside the containers is `root`, to workaround this the scripts in the containers fix the user of the output files after the benchmarks are run. If the benchmarks are interrupted, the owner of the datasets/results produced by the container will be wrong, and can be fixed by the user. | ||
|
|
||
| 2. **Using the preinstalled `raft_ann_benchmarks` python package**: The docker containers are built using the conda packages described in the following section, so they can be used directly as if they were installed manually following the instructions in the next section. This is the option that allows the full flexibility of the benchmarking scripts, and recommended for advanced users. This allows using the full flexibility of the scripts. To use the python scripts directly, an easy way is to use the following command: |
There was a problem hiding this comment.
Would it make sense to explain the conda install first and then the docker install? That way instead of saying "in the next section" where users haven't yet been exposed to the content, we can say "as outlined in the previous section" .
There was a problem hiding this comment.
Indeed, changed the order of the sections
cjnolet
reviewed
Oct 6, 2023
|
/merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding instructions to how to use the ANN benchmark containers, as well as general benchmark doc improvements.