-
Notifications
You must be signed in to change notification settings - Fork 156
Clarify the overall result in the GitHub comment. #1415
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
Clarify the overall result in the GitHub comment. #1415
Conversation
Here is a before and after comparison of a real comment. Finished benchmarking commit (b998821e4c51c44a9ebee395c91323c374236bbb): comparison url. Instruction count
Max RSS (memory usage)This benchmark run did not return any relevant results for this metric. CyclesResults
If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf. Next Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression Finished benchmarking commit (b998821e4c51c44a9ebee395c91323c374236bbb): comparison URL. Overall result: ❌✅ regressions and improvements - ACTION NEEDEDNext Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf. Instruction countThis is a highly reliable metric that was used to determine the overall result at the top of this comment.
Max RSS (memory usage)This benchmark run did not return any relevant results for this metric. CyclesResultsThis is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
Footnotes |
Specifics: - Adds a big "Overall result" heading at the top of the comment, which includes "ACTION NEEDED" when there are regressions. - Moves the next steps and "if you disagree..." text to the top of the comment, just below the overall result, before the tables of measurements. This means all the instructions that people need to read are in one place. - Removes the short summaries in front of each table, because (a) they just duplicates what the table says, and (b) saying "regressions found" for cycles and max-rss is a bit misleading because it doesn't contribute to the overall conclusion. Replaces them with a sentence indicating if the measurements contributed to the overall result and why. - Changes `Direction::join` to a non-static method, it's nicer that way.
7b34b1e
to
9716b16
Compare
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.
Looks great! I like that the actions to do and especially the overall is are now clearly visible at the beginning.
I have addressed the review comments. I also added " - no action needed" to the heading in the case where no action is needed, for a clearer contrast to the " - ACTION NEEDED" case. |
b84ae45
to
2bd9b6a
Compare
Specifics:
includes "ACTION NEEDED" when there are regressions.
comment, just below the overall result, before the tables of
measurements. This means all the instructions that people need to read
are in one place.
duplicates what the table says, and (b) saying "regressions found" for
cycles and max-rss is a bit misleading because it doesn't contribute
to the overall conclusion. Replaces them with a sentence indicating if
the measurements contributed to the overall result and why.
Direction::join
to a non-static method, it's nicer that way.