Skip to content

Update README a bit #286

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

Merged
merged 1 commit into from
Feb 9, 2025
Merged
Changes from all commits
Commits
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
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1311762.svg)](https://doi.org/10.5281/zenodo.1311762)

ReBench is a tool to run and document benchmark experiments.
Currently, it is mostly used for benchmarking language implementations,
Currently, it is often used for benchmarking language implementations,
but it can be used to monitor the performance of all
kinds of other applications and programs, too.

Expand All @@ -30,7 +30,7 @@ continued at a later time.
ReBench focuses on the execution aspect and does not provide advanced
analysis facilities itself. Instead, the recorded results should be processed
by dedicated tools such as scripts for statistical analysis in R, Python, etc,
or [Codespeed][1], for continuous performance tracking.
or [ReBenchDB][1], for continuous performance tracking.

The documentation for ReBench is hosted at [https://rebench.readthedocs.io/][docs].

Expand All @@ -43,7 +43,7 @@ ReBench is designed to
- provide a flexible execution model,
with support for interrupting and continuing benchmarking;
- enable the definition of complex sets of comparisons and their flexible execution;
- report results to continuous performance monitoring systems, e.g., [Codespeed][1];
- report results to continuous performance monitoring systems, e.g., [ReBenchDB][1];
- provide basic support for building/compiling benchmarks/experiments on demand;
- be extensible to parse output of custom benchmark harnesses.

Expand Down Expand Up @@ -90,7 +90,7 @@ To reduce noise generated by the system, `rebench-denoise` depends on:
- [`cpuset`](https://github.com/lpechacek/cpuset/) to reserve cores for benchmarking.
On Ubuntu: `apt install cpuset`

Please note that `rebench-denoise` is only tested on Ubuntu. It is designed to degrade
`rebench-denoise` is currently tested on Ubuntu and Rocky Linux. It is designed to degrade
gracefully and report the expected implications when it cannot adapt system
settings. See the [docs][denoise-docs] for details.

Expand Down Expand Up @@ -149,8 +149,7 @@ In case you encounter issues,
please feel free to [open an issue](https://github.com/smarr/rebench/issues/new)
so that we can help.

For contributions, we use the [normal GitHub flow](https://guides.github.com/introduction/flow/)
of pull requests, discussion, and revisions. For larger contributions,
For contributions, we use pull requests. For larger contributions,
it is likely useful to discuss them upfront in an issue first.

### Development Setup
Expand Down Expand Up @@ -182,14 +181,14 @@ citing it.
The preferred citation is:

```bibtex
@misc{ReBench:2018,
@misc{ReBench:2025,
author = {Marr, Stefan},
doi = {10.5281/zenodo.1311762},
month = {August},
note = {Version 1.0},
month = {February},
note = {Version 1.3},
publisher = {GitHub},
title = {ReBench: Execute and Document Benchmarks Reproducibly},
year = 2018
year = 2025
}
```

Expand All @@ -211,6 +210,6 @@ Some publications that have been using ReBench include:
- [Identifying A Unifying Mechanism for the Implementation of Concurrency Abstractions on Multi-Language Virtual Machines](https://www.stefan-marr.de/downloads/tools12-smarr-dhondt-identifying-a-unifying-mechanism-for-the-implementation-of-concurrency-abstractions-on-multi-language-virtual-machines.pdf), S. Marr, T. D'Hondt. 2012.
- [Insertion Tree Phasers: Efficient and Scalable Barrier Synchronization for Fine-grained Parallelism](https://www.stefan-marr.de/downloads/hpcc2010-marr-etal-insertion-tree-phasers.pdf), S. Marr et al. 2011.

[1]: https://github.com/tobami/codespeed/
[1]: https://github.com/smarr/ReBenchDB
[docs]: https://rebench.readthedocs.io/
[denoise-docs]: https://rebench.readthedocs.io/en/latest/denoise/