Skip to content

Commit

Permalink
FIx prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
MrFlashAccount committed Dec 22, 2024
1 parent 6492f7d commit 5c8beb3
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions tools/performance/engine-benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,26 @@ One can also download only a CSV file representing all the selected benchmark
results with `bench_download.py --create-csv`.

## Contribute

Run local tests with:

```bash
python -m unittest --verbose bench_tool/test*.py
```

## Relation to GH Actions
The `bench_download.py` script is used in [Benchmarks Upload](https://github.com/enso-org/enso/actions/workflows/bench-upload.yml)
GH Action to download the benchmarks generated by the [Benchmark Engine](https://github.com/enso-org/enso/actions/workflows/engine-benchmark.yml)
and [Benchmark Standard Libraries](https://github.com/enso-org/enso/actions/workflows/std-libs-benchmark.yml) GH Actions.
The `Benchmarks Upload` action is triggered by the `engine-benchmark.yml` and `std-libs-benchmark.yml` actions.

The results from the benchmarks are gathered from the GH artifacts associated with corresponding workflow runs, and
save as JSON files inside https://github.com/enso-org/engine-benchmark-results repo inside its
[cache](https://github.com/enso-org/engine-benchmark-results/tree/main/cache) directory.

The `bench_download.py` script is used in
[Benchmarks Upload](https://github.com/enso-org/enso/actions/workflows/bench-upload.yml)
GH Action to download the benchmarks generated by the
[Benchmark Engine](https://github.com/enso-org/enso/actions/workflows/engine-benchmark.yml)
and
[Benchmark Standard Libraries](https://github.com/enso-org/enso/actions/workflows/std-libs-benchmark.yml)
GH Actions. The `Benchmarks Upload` action is triggered by the
`engine-benchmark.yml` and `std-libs-benchmark.yml` actions.

The results from the benchmarks are gathered from the GH artifacts associated
with corresponding workflow runs, and save as JSON files inside
https://github.com/enso-org/engine-benchmark-results repo inside its
[cache](https://github.com/enso-org/engine-benchmark-results/tree/main/cache)
directory.

0 comments on commit 5c8beb3

Please sign in to comment.