From cf5af262314a7741134cba9da65a828bb63c90ee Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Sat, 11 Jul 2020 02:02:15 +0100 Subject: [PATCH] document benchmarks, revert debug --- .github/workflows/bench.yml | 2 +- benchmarks/README.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 benchmarks/README.md diff --git a/.github/workflows/bench.yml b/.github/workflows/bench.yml index 333580e4..1015edda 100644 --- a/.github/workflows/bench.yml +++ b/.github/workflows/bench.yml @@ -5,7 +5,7 @@ on: - cron: '36 1 * * SUN' # M H d m w (Sundays at 01:36) jobs: asvfull: - # if: (github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || github.event_name == 'schedule' + if: (github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || github.event_name == 'schedule' name: Full runs-on: ubuntu-latest steps: diff --git a/benchmarks/README.md b/benchmarks/README.md new file mode 100644 index 00000000..a4e2e528 --- /dev/null +++ b/benchmarks/README.md @@ -0,0 +1,24 @@ +# Benchmarks + +These benchmarks serve two purposes: + +1. Thorough performance tests against regression + - `tqdm` + - `tqdm(miniters=manually_optimised, smoothing=0)` + - `no-progress` (empty loop without progress wrapper) +2. Compare `tqdm`'s speed to popular alternatives + - [`rich.progress`](https://pypi.org/project/rich) + - [`progressbar2`](https://pypi.org/project/progressbar2) + - [`alive-progress`](https://pypi.org/project/alive-progress) + +Performance graphs are available at + +## Running + +These benchmarks are run automatically for all releases and pull requests. + +To run locally: + +- conda/pip install `virtualenv` and `asv` +- clone this repository +- run `asv --help` in the repository root (one directory above this file)