erick-xanadu / catalyst Goto Github PK

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.

• 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 the Lightning high performance simulator. Additional hardware support, including GPUs and QPUs to come.

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 based on QIR that enables the execution of Catalyst-compiled quantum programs. Currently, a runtime implementation is available for the state-vector simulators Lightning. A complete list of the quantum instruction set supported by these runtime implementations can be found by visiting the Catalyst 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.

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

pip install pennylane-catalyst

Pre-built packages for Windows and MacOS are not yet available, and comptability with those platforms is untested and cannot be guaranteed. If you are using one of these platforms, please try out our Docker and Dev Container images described in the documentation or click this button:

.

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

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.

• 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.

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.

• Source Code: https://github.com/PennyLaneAI/catalyst
• Issue Tracker: https://github.com/PennyLaneAI/catalyst/issues

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.

Catalyst is the work of many contributors.

If you are doing research using Catalyst, please cite our GitHub repo.

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