Skip to content

Fix documentation for PlainSecondsLogAdapter #293

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.

Sign up for GitHub

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
smarr merged 1 commit into from
Apr 24, 2026
Merged

Fix documentation for PlainSecondsLogAdapter #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ They typically parse the output generated by harnesses.
ReBench currently provides builtin support for the following benchmark harnesses:

- `JMH`: [JMH](http://openjdk.java.net/projects/code-tools/jmh/), Java's microbenchmark harness
- `PlainSecondsLog`: a plain seconds log, i.e., a floating point number per line
- `PlainSecondsLog`: a plain seconds log, i.e., a floating point number per line in seconds
- `ReBenchLog`: the ReBench log format, which indicates benchmark name and run time in milliseconds or microseconds
- `SavinaLog`: the harness of the [Savina](https://github.com/shamsimam/savina) benchmarks
- `ValidationLog`: the format used by [SOMns](https://github.com/smarr/SOMns)'s ImpactHarness
Expand All @@ -19,8 +19,8 @@ ReBench currently provides builtin support for the following benchmark harnesses

### `PlainSecondsLog`

This adapter attempts to read every line of program output as a millisecond
measurement. Lines which cannot be parsed as floats are skipped, e.g. `1.0` and
This adapter attempts to read every line of program output as measurement
in seconds. Lines which cannot be parsed as floats are skipped, e.g. `1.0` and
` 2 ` are valid, while `out: 1` and `1, 2, 3` are not and would be ignored.

Example output from a harness or benchmark:
Expand Down
4 changes: 2 additions & 2 deletions rebench/interop/plain_seconds_log_adapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@


class PlainSecondsLogAdapter(GaugeAdapter):
"""PlainSecondsLogAdapter expects a plain list of numbers, one per line.
It can also contain error information.
"""PlainSecondsLogAdapter expects a plain list of numbers, one per line
in seconds. It can also contain error information.
"""
re_NPB_partial_invalid = re.compile(r".*Failed.*verification")
re_NPB_invalid = re.compile(r".*Benchmark done.*verification failed")
Expand Down