DOC Add airspeed benchmarks page link to the contributing docs #22075
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
lorentzenchr
approved these changes
Dec 27, 2021
doc/developers/contributing.rst
Outdated
| @@ -934,8 +934,9 @@ Monitoring performance | |||
| When proposing changes to the existing code base, it's important to make sure | |||
| that they don't introduce performance regressions. Scikit-learn uses | |||
| `asv benchmarks <https://github.com/airspeed-velocity/asv>`_ to monitor the | |||
| performance of a selection of common estimators and functions. The benchmark | |||
| suite can be found in the `scikit-learn/asv_benchmarks` directory. | |||
| performance of a selection of common estimators and functions, you can view | |||
There was a problem hiding this comment.
Suggested change
| performance of a selection of common estimators and functions, you can view | |
| performance of a selection of common estimators and functions. You can view |
There was a problem hiding this comment.
Thanks for the suggestion! Now added :)
doc/developers/contributing.rst
Outdated
| suite can be found in the `scikit-learn/asv_benchmarks` directory. | ||
| performance of a selection of common estimators and functions, you can view | ||
| these benchmarks on the `scikit-learn benchmark page <https://scikit-learn.org/scikit-learn-benchmarks>`_. | ||
| The benchmark suite can be found in the `scikit-learn/asv_benchmarks` directory. |
There was a problem hiding this comment.
Suggested change
| The benchmark suite can be found in the `scikit-learn/asv_benchmarks` directory. | |
| The corresponding benchmark suite can be found in the `scikit-learn/asv_benchmarks` directory. |
There was a problem hiding this comment.
This makes things a lot clearer, thanks! Added as well.
venkyyuvy
pushed a commit
to venkyyuvy/scikit-learn
that referenced
this pull request
Jan 1, 2022
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.
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Fixes #21898
Added a link to the airspeed benchmarks page in
doc/developers/contributing.rstunder the intro paragraph of the Monitoring Performance section as suggested by @ogriselAny other comments?
I think it should be pretty clear now, but please let me know if you would like me to change anything about the phrasing. Thanks!