4.4 KiB

Raw Permalink Blame History

Benchmarks

All benchmarks were computed on macOS using Python 3.12 (for non-Puffin tools), and come with a few important caveats:

Benchmark performance may vary dramatically across different operating systems and filesystems. In particular, Puffin uses different installation strategies based on the underlying filesystem's capabilities. (For example, Puffin uses reflinking on macOS, and hardlinking on Linux.)
Benchmark performance may vary dramatically depending on the set of packages being installed. For example, a resolution that requires building a single intensive source distribution may appear very similar across tools, since the bottleneck is tool-agnostic.
Unlike Poetry, both Puffin and pip-tools do not generate multi-platform lockfiles. As such, Poetry is (by design) doing significantly more work than other tools in the resolution benchmarks. Poetry is included for completeness, as many projects may not need a multi-platform lockfile. However, it's critical to understand that benchmarking Puffin's resolution time against Poetry is an unfair comparison. (Benchmarking installation, however, is a fair comparison.)

This document benchmarks against Trio's docs-requirements.in, as a representative example of a real-world project.

In each case, a smaller bar (i.e., lower) is better.

Warm Installation

Benchmarking package installation (e.g., puffin pip sync) with a warm cache. This is equivalent to removing and recreating a virtual environment, and then populating it with dependencies that you've installed previously on the same machine.

Cold Installation

Benchmarking package installation (e.g., puffin pip sync) with a cold cache. This is equivalent to running puffin pip sync on a new machine or in CI (assuming that the package manager cache is not shared across runs).

Warm Resolution

Benchmarking dependency resolution (e.g., puffin pip compile) with a warm cache, but no existing lockfile. This is equivalent to blowing away an existing requirements.txt file to regenerate it from a requirements.in file.

Cold Resolution

Benchmarking dependency resolution (e.g., puffin pip compile) with a cold cache. This is equivalent to running puffin pip compile on a new machine or in CI (assuming that the package manager cache is not shared across runs).

Reproduction

All benchmarks were generated using the scripts/bench/__main__.py script, which wraps hyperfine to facilitate benchmarking Puffin against a variety of other tools.

The benchmark script itself has a several requirements:

A local Puffin release build (cargo build --release).
A virtual environment with the script's own dependencies installed (puffin venv && puffin pip sync scripts/bench/requirements.txt).
The hyperfine command-line tool installed on your system.

To benchmark Puffin's resolution against pip-compile and Poetry:

python -m scripts.bench \
    --puffin \
    --poetry \
    --pip-compile \
    --benchmark resolve-warm \
    scripts/requirements/trio.in \
    --json

To benchmark Puffin's installation against pip-sync and Poetry:

python -m scripts.bench \
    --puffin \
    --poetry \
    --pip-sync \
    --benchmark resolve-warm \
    scripts/requirements/compiled/trio.txt \
    --json

After running the benchmark script, you can generate the corresponding graph via:

cargo run -p puffin-dev render-benchmarks resolve-warm.json --title "Warm Resolution"
cargo run -p puffin-dev render-benchmarks resolve-cold.json --title "Cold Resolution"
cargo run -p puffin-dev render-benchmarks install-warm.json --title "Warm Installation"
cargo run -p puffin-dev render-benchmarks install-cold.json --title "Cold Installation"

Acknowledgements

The inclusion of this BENCHMARKS.md file was inspired by the excellent benchmarking documentation in Orogene.

4.4 KiB Raw Permalink Blame History