Skip to content

Revise benchmark results in README.md#415

Open
RellikSai wants to merge 2 commits into
objectionary:masterfrom
RellikSai:patch-2
Open

Revise benchmark results in README.md#415
RellikSai wants to merge 2 commits into
objectionary:masterfrom
RellikSai:patch-2

Conversation

@RellikSai

Copy link
Copy Markdown

The Benchmark section in README contained an empty code block, which could confuse users about whether benchmarking is available or functioning. Added example output showing typical bytecode size and performance improvements to clarify expected behavior. This provides useful context until CI benchmarking artifacts are integrated into README generation.

Updated benchmark results for optimizing a large Java class, including bytecode size and execution time before and after optimization.
Removed extra newline before benchmark results section.
@RellikSai

RellikSai commented Feb 5, 2026

Copy link
Copy Markdown
Author

Hi! @yegor256
Just wanted to gently follow up on this PR when you have a moment.
No rush at all...
Happy to make any changes if needed.
Thank You So Much for your time

@edmoffo edmoffo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes. Two inline comments name correctness defects: the inserted block sits inside an auto-populated region, and the new metrics misrepresent what this plugin measures.

Comment thread README.md
<!-- benchmark_begin -->
```text
```bash
Benchmark results for optimizing a large Java class:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block sits between <!-- benchmark_begin --> and <!-- benchmark_end -->, which on master is overwritten by the benchmark GHA run that recomputes the section. The hardcoded numbers will be erased the next time that workflow updates the README, so the change is ephemeral. If the goal is to document expected output until the GHA wiring lands, place the example outside the markers, or remove the markers from the README entirely.

Comment thread README.md

After optimization:
Bytecode size: 118,742 bytes
Execution time: 103.1 ms

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Execution time and Speedup describe runtime performance of the optimized program, but the existing benchmark output on master reports Size of .class, Size of .xmir, Size of .phi, and Optimization time of the transformation itself, not bytecode execution. The plugin does not measure runtime speedup, so presenting ~1.24x faster as a sample result misrepresents what the tool does. Align the example with the four fields the benchmark workflow actually emits.

Comment thread README.md
@@ -96,9 +96,20 @@ Here is the result of the latest processing of a large Java class
from [JNA](https://github.com/java-native-access/jna):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The language hint changed from text to bash, but the content is plain benchmark output with no shell syntax. Revert to text so highlighters do not color stray tokens as shell commands.

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.

2 participants