Skip to content

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 2 commits into from
Mar 23, 2025
Merged

Conversation

sylvestre
Copy link
Contributor

No description provided.

@sylvestre sylvestre requested a review from Copilot March 23, 2025 09:04
Copy link

@Copilot Copilot AI left a 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

Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/timeout/timeout (fails in this run but passes in the 'main' branch)

Co-authored-by: Daniel Hofstetter <[email protected]>
Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/timeout/timeout (fails in this run but passes in the 'main' branch)

@cakebaker cakebaker merged commit 105042f into uutils:main Mar 23, 2025
66 of 68 checks passed
@cakebaker
Copy link
Contributor

Good work :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants