docs: Add documentation about benchmarks and campaigns #208
Conversation
This file contains hidden or 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
|
thanks for the documentation update! We will review it asap. |
To not make the code lines be too long
This is to avoid confusion with the examples used in `docs/benchmark.md`
Using `tilt` is deprecated, so the `get_tilt_var_names` function should not longer be used, but since, every time it was called, this function returned a `notImplementedError`, this function still had to be overwritten every time you wanted to create a new benchmark class. Returning an empty list by default fixes this.
|
This PR would fix #11 |
…names`" This reverts commit 413eec7.
This method is no longer required starting form commit dcb183e. The documentation mentions that it should be added for people that use an older version.
Remove the warning stating that older versions need to override the `get_tilt_vars` method, since this is incorrect.
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.
Add some documentation, this is mainly about how to create and run campaigns and benchmarks.