Add nnbench CLI guide #179
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
…omparison This makes it easier to see which records the rows come from.
Contains all commands, their usages and use scenarios, and an appendix section on how to configure the CLI experience via `pyproject.toml`.
maxmynter
approved these changes
Dec 2, 2024
|
Agree 100% on all points - will add them over the course of the evening. |
This is the most sensible configuration I can think of. We can decide if we want to restructure the documents currently under "User Guide" into a section such as "Python SDK".
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.
Contains all commands, their usages and use scenarios, and an appendix section on how to configure the CLI experience via
pyproject.toml.I also made two small tweaks to the CLI, namely printing help when calling
nnbenchwithout any arguments, and displaying the benchmark run name in comparison tables rendered bynnbench compare.