Skip to main content

A JIT compiler for hybrid quantum programs in PennyLane

Project description

Tests Coverage Documentation DOI PyPI Forum License

Catalyst is an experimental package that enables just-in-time (JIT) compilation of hybrid quantum-classical programs.

Catalyst is currently under heavy development — if you have suggestions on the API or use-cases you'd like to be covered, please open an GitHub issue or reach out. We'd love to hear about how you're using the library, collaborate on development, or integrate additional devices and frontends.

Key Features

  • Compile the entire quantum-classical workflow, including any optimization loops.

  • Use Catalyst alongside PennyLane directly from Python. Simply decorate quantum code and hybrid functions with @qjit, leading to significant performance improvements over standard Python execution.

  • Access advanced control flow that supports both quantum and classical instructions.

  • Infrastructure for both quantum and classical compilation, allowing you to compile quantum circuits that contain control flow.

  • Built to be end-to-end differentiable.

  • Support for PennyLane-Lightning high performance simulators, and Amazon Braket devices. Additional hardware support, including QPUs, to come.

Overview

Catalyst currently consists of the following components:

  • Catalyst Compiler.

    The core Catalyst compiler is built using MLIR, with the addition of a quantum dialect used to represent quantum instructions. This allows for a high-level intermediate representation of the classical and quantum components of the program, resulting in advantages during optimization. Once optimized, the compiler lowers the representation down to LLVM + QIR, and a machine binary is produced.

  • Catalyst Runtime.

    The runtime is a C++ runtime with multiple-device support based on QIR that enables the execution of Catalyst-compiled quantum programs. A complete list of all backend devices along with the quantum instruction set supported by these runtime implementations can be found by visiting the runtime documentation.

In addition, we also provide a Python frontend for PennyLane and JAX:

  • PennyLane JAX frontend.

    A Python library that provides a @qjit decorator to just-in-time compile PennyLane hybrid quantum-classical programs. In addition, the frontend package provides Python functions for defining Catalyst-compatible control flow structures, gradient, and mid-circuit measurement.

Installation

Catalyst is officially supported on Linux (x86_64, aarch64) and macOS (arm64) platforms, and pre-built binaries are being distributed via the Python Package Index (PyPI) for Python versions 3.11 and higher. To install it, simply run the following pip command:

pip install pennylane-catalyst

Catalyst no longer supports macOS with x86_64 architecture after 0.11.0. This includes Macs running on Intel processors. If you would like to use Catalyst on these systems, please install Catalyst version 0.11.0, PennyLane version 0.41.0, PennyLane-Lightning version 0.41.0, and Jax version 0.4.28:

pip install pennylane-catalyst==0.11.0
pip install pennylane==0.41.0
pip install pennylane-lightning==0.41.0
pip install jax==0.4.28

If you wish to contribute to Catalyst or develop against our runtime or compiler, instructions for building from source are also available.

Trying Catalyst with PennyLane

To get started using the Catalyst JIT compiler from Python, check out our quick start guide, as well as our various examples and tutorials in our documentation.

For an introduction to quantum computing and quantum machine learning, you can also visit the PennyLane website for tutorials, videos, and demonstrations.

Roadmap

  • Frontend: As we continue to build out Catalyst, the PennyLane frontend will likely be upstreamed into PennyLane proper, providing native JIT functionality built-in to PennyLane. The Catalyst compiler and runtime will remain part of the Catalyst project. If you are interested in working on additional frontends for Catalyst, please get in touch.

  • Compiler: We will continue to build out the compiler stack, and add quantum compilation routines. This includes an API for providing or writing Catalyst-compatible compilation routines. In addition, we will be improving the autodifferentiation support, and adding support for classical autodiff, additional quantum gradients, and quantum-aware optimization methods.

  • Runtime: We will be adding support for more devices, including quantum hardware devices. In addition, we will be building out support for hetereogeneous execution. If you are interested in working on connecting a quantum device with Catalyst, please get in touch.

To get the details right, we need your help — please send us your use cases by starting a conversation, or trying Catalyst out.

Contributing to Catalyst

We welcome contributions — simply fork the Catalyst repository, and then make a pull request containing your contribution.

We also encourage bug reports, suggestions for new features and enhancements.

Support

If you are having issues, please let us know by posting the issue on our GitHub issue tracker.

We also have a PennyLane discussion forum—come join the community and chat with the PennyLane team.

Note that we are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the Code of Conduct.

Authors

Catalyst is the work of many contributors.

If you are doing research using Catalyst, please cite our paper:

@article{
  Ittah2024,
  doi = {10.21105/joss.06720},
  url = {https://doi.org/10.21105/joss.06720},
  year = {2024},
  publisher = {The Open Journal},
  volume = {9},
  number = {99},
  pages = {6720},
  author = {David Ittah and Ali Asadi and Erick Ochoa Lopez and Sergei Mironov and Samuel Banning and Romain Moyard and Mai Jacob Peng and Josh Izaac},
  title = {Catalyst: a Python JIT compiler for auto-differentiable hybrid quantum programs},
  journal = {Journal of Open Source Software}
}

License

Catalyst is free and open source, released under the Apache License, Version 2.0.

Acknowledgements

Catalyst makes use of the following libraries and tools, which are under their own respective licenses:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_x86_64.whl (80.6 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.28+ x86-64

pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_aarch64.whl (80.3 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.28+ ARM64

pennylane_catalyst-0.14.0-cp312-abi3-macosx_13_0_arm64.whl (75.2 MB view details)

Uploaded CPython 3.12+macOS 13.0+ ARM64

pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_x86_64.whl (80.7 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_aarch64.whl (80.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ ARM64

pennylane_catalyst-0.14.0-cp311-cp311-macosx_13_0_arm64.whl (75.0 MB view details)

Uploaded CPython 3.11macOS 13.0+ ARM64

File details

Details for the file pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 6332ef5ca82eae639d6042628c4f8ecaa82cc81e94d609fbc8bb802392c3906d
MD5 9f81035f6111a8039f61530a9aace329
BLAKE2b-256 e52894198089b56d86d52d4fd6d26d0f0d2799a6394fd6d20f1e71c370304d5a

See more details on using hashes here.

File details

Details for the file pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp312-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 dd79d732fcbe3d063d0a63e0a4f94fd798b7baafc3b34d0cae75291f6e7650b2
MD5 b39eff0c1c52ac5ad9d1051765970dbc
BLAKE2b-256 60d324aec66ba1b1a9ffd78845e90ceeb0aad570460ad2e78e5fb04077ab26fe

See more details on using hashes here.

File details

Details for the file pennylane_catalyst-0.14.0-cp312-abi3-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp312-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 61814a663a9bf34241105f137517e5083ccd08b81fa3f1ece8b80f0149324612
MD5 42616b85659393bb50d78f564da6a259
BLAKE2b-256 0565c9caaf31a5fd032394a37b68da6d887cdd20c4fc09ccb5b429be44e3da7a

See more details on using hashes here.

File details

Details for the file pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e0dd678c64d0608c99fd334c5603b35d54dbf8ab2ea6cdf22c2a78ab946615d4
MD5 1a5824203609c55d6ba1fb14821fcd0a
BLAKE2b-256 1c8753968b11acc403a28134d92f5f9159fb7445eb05faccb5ee63facef41652

See more details on using hashes here.

File details

Details for the file pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp311-cp311-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 941a03d1b36e17427eec16cae661643044aa64875ebb6a39a3cc0dbdf2e5e1b9
MD5 6236b78ef1b3a03bd0e3c720b86053fc
BLAKE2b-256 40ddc800afb25698d29fc59ba8940756cb9521372a7681d67f61d3c64f3a08d0

See more details on using hashes here.

File details

Details for the file pennylane_catalyst-0.14.0-cp311-cp311-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pennylane_catalyst-0.14.0-cp311-cp311-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 aef8ecb78ccafffbc336de53365685fa183f51fc77400da9ed82470b724643bc
MD5 c3ca0aaf6e250f07d533e8ae951adde7
BLAKE2b-256 9f89f578694ffbf092b9325ccc22c91683165c62ebb0cb14b7ad06a7242f9eb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page