Cirq Performance Benchmarks

This directory concerns doing Cirq performance benchmarks 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 the following command:

./check/asv_run

You can also pass arguments to the asv_run script, which will be forwarded to the asv run command. Here's an example:

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

Please refer to Running Benchmarks guide by ASV for more information.

Results Database

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