Skip to content

Commit e5a50d8

Browse files
committed
docs: add info about file sizes in benchmarks
1 parent 5fabaee commit e5a50d8

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Options
3535

3636
### Benchmark 1
3737

38+
- Git diff file: 40MB size and 1,808,684 lines long
39+
- Coverage file: 46MB size and 1,115,971 lines long
40+
3841
| Metric | Rust | Python | Improvement (Python / Rust) |
3942
|---|---:|---:|---:|
4043
| Mean wall time | 2.47s | 108.23s | 43.90× |
@@ -44,6 +47,9 @@ Options
4447

4548
### Benchmark 2
4649

50+
- Git diff file: 40MB size and 1,808,684 lines long
51+
- 50 coverage files: each 620KB size and 24,116 lines long
52+
4753
| Metric | Rust | Python | Improvement (Python / Rust) |
4854
|---|---:|---:|---:|
4955
| Mean wall time | 2.10s | 227.24s | 108.24× |
@@ -52,7 +58,7 @@ Options
5258
| Max peak RSS | 22.84 MB | 494.64 MB | 21.65× |
5359

5460
*Peak RSS shown in MB (kB ÷ 1024).*
55-
[Full benchmark results](coverage-download/diff_cover_benchmark_comparison.md)
61+
[Full benchmark results](docs/benchmark_results.md)
5662

5763
## Installation
5864

@@ -66,6 +72,13 @@ Download the prebuilt archives from the [GitHub Releases page](https://github.co
6672
cargo install diff-coverage
6773
```
6874

75+
### Docker
76+
77+
```bash
78+
docker run --rm -v "$PWD":/work -w /work <dockerhub-user>/diff-coverage:latest \
79+
coverage.xml --diff-file diff.diff
80+
```
81+
6982
## Build
7083

7184
```bash

docs/benchmark_results.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Parsed GNU time output from .log files under `coverage-download/`. Percentiles u
77
## Benchmark 1
88
- Python logs: 100 files
99
- Rust logs: 106 files
10+
- Git diff file: 40MB size and 1,808,684 lines long
11+
- Coverage file: 46MB size and 1,115,971 lines long
1012

1113
#### Elapsed wall time (seconds)
1214
| Stat | Python | Rust |
@@ -91,6 +93,8 @@ Parsed GNU time output from .log files under `coverage-download/`. Percentiles u
9193
## Benchmark 2
9294
- Python logs: 101 files
9395
- Rust logs: 100 files
96+
- Git diff file: 40MB size and 1,808,684 lines long
97+
- 50 coverage files: each 620KB size and 24,116 lines long
9498

9599
#### Elapsed wall time (seconds)
96100
| Stat | Python | Rust |

0 commit comments

Comments
 (0)