Skip to content
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

Add hyperfine installation instructions; update hyperfine code samples #13034

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

olp-cs
Copy link
Contributor

@olp-cs olp-cs commented Aug 21, 2024

Summary

When following the step-by-step instructions to run the benchmarks in CONTRIBUTING.md, I encountered two errors:

Error 1:
bash: hyperfine: command not found

Solution: I updated the instructions to include the step of installing the benchmark tool.

Error 2:

$ ./target/release/ruff ./crates/ruff_linter/resources/test/cpython/ 
error: `ruff <path>` has been removed. Use `ruff check <path>` instead.

Solution: I added check.

Test Plan

I tested it by running the benchmark-related commands in a new workspace within GitHub Codespaces.

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Aug 21, 2024
@charliermarsh
Copy link
Member

I'm a little mixed on adding hyperfine to the dev container since most contributors won't need to run benchmarks, but not strongly opposed at all.

@olp-cs
Copy link
Contributor Author

olp-cs commented Aug 21, 2024

most contributors won't need to run benchmarks

I agree, that makes sense! I will revert this change.

@olp-cs olp-cs changed the title Add hyperfine installation instructions to docs and .devcontainer; update hyperfine code samples Add hyperfine installation instructions; update hyperfine code samples Aug 21, 2024
Copy link

codspeed-hq bot commented Aug 21, 2024

CodSpeed Performance Report

Merging #13034 will degrade performances by 7.41%

Comparing olp-cs:hyperfine (c2f0d1f) with main (ecd9e6a)

Summary

❌ 1 regressions
✅ 31 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main olp-cs:hyperfine Change
linter/default-rules[numpy/globals.py] 170.5 µs 184.2 µs -7.41%

@dhruvmanila dhruvmanila merged commit 93f9023 into astral-sh:main Aug 22, 2024
19 checks passed
@olp-cs olp-cs deleted the hyperfine branch August 22, 2024 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants