-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
document how to do good performance work #7541
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
Merged
Merged
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a new documentation page that explains how to profile and benchmark performance improvements using tools like Hyperfine and Samply. Key changes include:
- A step-by-step tutorial on setting up performance benchmarks.
- Example commands for both benchmarking with Hyperfine and profiling with Samply.
- A workflow outlining the process from baseline measurement to verifying improvements.
Comments suppressed due to low confidence (1)
docs/src/performance.md:7
- [nitpick] Consider using consistent list formatting for the benchmarking steps outlined in this section. For instance, using numbered lists consistently rather than mixing numbered steps (lines 11-13) with bullet points (lines 16-17) could improve clarity.
### Benchmarking Best Practices
drinkcat
reviewed
Mar 23, 2025
GNU testsuite comparison:
|
cakebaker
reviewed
Mar 23, 2025
Co-authored-by: Daniel Hofstetter <[email protected]>
GNU testsuite comparison:
|
Good work :) |
This was referenced May 24, 2025
This was referenced May 25, 2025
1 task
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.
No description provided.