benchmark: add README documenting how to run benchmarks (#8574)#9144
Open
luongs3 wants to merge 1 commit into
Open
benchmark: add README documenting how to run benchmarks (#8574)#9144luongs3 wants to merge 1 commit into
luongs3 wants to merge 1 commit into
Conversation
Adds benchmark/README.md covering the common ways to run the benchmarks: the benchmain driver and baseline comparison via benchresult, the run_bench.sh parameter sweep, and the go test -bench micro-benchmarks, plus a directory overview. Links to it from CONTRIBUTING.md so authors and reviewers can find it when a performance PR needs benchmark results. Fixes grpc#8574. RELEASE NOTES: n/a
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #9144 +/- ##
==========================================
- Coverage 83.16% 83.09% -0.07%
==========================================
Files 417 417
Lines 33690 33690
==========================================
- Hits 28019 27996 -23
- Misses 4253 4268 +15
- Partials 1418 1426 +8 🚀 New features to boost your workflow:
|
Contributor
|
@luongs3: Could you please sign the CLA for us to start reviewing the changes. |
easwars
added
Status: Requires Reporter Clarification
Area: Benchmarking
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #8574.
Adds a
README.mdto thebenchmark/directory documenting the commonly used ways to run the benchmarks, and links to it fromCONTRIBUTING.md.What's covered
benchmain— the primary configurable driver, with the canonical example invocation (mirrors the package doc inbenchmark/benchmain/main.go) and the recommended baseline-capture-then-compare workflow usingbenchresult.run_bench.sh— the shell harness that sweeps parameter combinations.go test -benchfor packages likeprimitivesandlatency.The
CONTRIBUTING.mdlink is added under the testing bullet in "Guidelines for Pull Requests", so authors and reviewers can find it when a performance-focused PR needs benchmark results — which is the motivation in the issue.Verification
The documented commands were run against the current tree:
go run benchmark/benchmain/main.go -hlists the flags.go test -bench=BenchmarkCodeStringSwitch -benchmem -run='^$' ./benchmark/primitives/runs and passes.No code changes; docs only.
RELEASE NOTES: n/a