README.md

Cirq Performance Benchmarks

Performance benchmarking Cirq with Airspeed Velocity.

Overview

The benchmark files (bench_*.py) stored in the current package (benchmarks/*) are used by asv to run benchmark tests for Cirq. For more information on how to write new benchmarks, please refer Writing benchmarks guide by ASV

Usage

To run all benchmarks, navigate to the root Cirq directory at the command line and execute

./check/asv_run

You can also pass arguments to the script, which would be forwarded to the asv run command. For eg:

./check/asv_run --quick --bench bench_examples --python 3.9

Please refer Running Benchmarks guide by ASV for more information.

Results Database

TODO(#3838): Add details regarding GCP setup.