-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add devices page to the documentation (#966)
**Context:** There is currently no clear place in the Catalyst docs that lists supported devices. **Description of the Change:** - Adds a page to the docs listing supported devices. - Removes lists of supported ops/observables from the quick start (since supported ops might differ per device) - Updated `qjit` docstring to point to the new device page **Benefits:** - Easier to see in one place all supported devices **Possible Drawbacks:** - I noticed the table in the runtime README (https://github.com/PennyLaneAI/catalyst/blob/main/runtime/README.rst#backend-devices) is no longer up to date. - For each of the devices, I linked to the TOML files so that a reader can easily see what is supported. However, the TOML file is not one-to-one in terms of what a user might experience, since Catalyst may decompose a unsupported operation to a supported one. **Related GitHub Issues:** n/a --------- Co-authored-by: David Ittah <[email protected]> Co-authored-by: Isaac De Vlugt <[email protected]>
- Loading branch information
3 people
authored
Jul 31, 2024
1 parent
a8c1a96
commit 8cb6872
Showing
5 changed files
with
108 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <style> | ||
| tr { | ||
| border-top: #d3d3d3 1px solid; | ||
| border-bottom: #d3d3d3 1px solid; | ||
| } | ||
| .row-odd { | ||
| background-color: #f7f7f7; | ||
| } | ||
| </style> | ||
|
|
||
| Supported devices | ||
| ================= | ||
|
|
||
| Not all PennyLane devices currently work with Catalyst, and for those that do, their supported | ||
| feature set may not necessarily match supported features when used without :func:`~.qjit`. | ||
|
|
||
| Supported backend devices include: | ||
|
|
||
| .. list-table:: | ||
| :widths: 20 80 | ||
|
|
||
| * - ``lightning.qubit`` | ||
|
|
||
| - A fast state-vector qubit simulator written with a C++ backend. See the | ||
| `Lightning documentation <https://docs.pennylane.ai/projects/lightning/en/stable/lightning_qubit/device.html>`__ | ||
| for more details, as well as its | ||
| `Catalyst configuration file <https://github.com/PennyLaneAI/pennylane-lightning/blob/master/pennylane_lightning/lightning_qubit/lightning_qubit.toml>`__ | ||
| for natively supported instructions. | ||
|
|
||
| * - ``lightning.kokkos`` | ||
|
|
||
| - A fast state-vector qubit simulator utilizing the Kokkos library for CPU and GPU accelerated | ||
| circuit simulation. See the | ||
| `Lightning documentation <https://docs.pennylane.ai/projects/lightning/en/stable/lightning_kokkos/device.html>`__ | ||
| for more details, as well as its | ||
| `Catalyst configuration file <https://github.com/PennyLaneAI/pennylane-lightning/blob/master/pennylane_lightning/lightning_kokkos/lightning_kokkos.toml>`__ | ||
| for natively supported instructions. | ||
|
|
||
| * - ``braket.aws.qubit`` | ||
|
|
||
| - Interact with quantum computing hardware devices and simulators through Amazon Braket. To use | ||
| this device with Catalyst, make sure to install the | ||
| `PennyLane-Braket plugin <https://amazon-braket-pennylane-plugin-python.readthedocs.io/en/latest/>`__. | ||
| See the | ||
| `Catalyst configuration file <https://github.com/PennyLaneAI/catalyst/blob/main/runtime/lib/backend/openqasm/braket_aws_qubit.toml>`__ | ||
| for natively supported instructions. | ||
|
|
||
| * - ``braket.local.qubit`` | ||
|
|
||
| - Run gate-based circuits on the Braket SDK's local simulator. To use | ||
| this device with Catalyst, make sure to install the | ||
| `PennyLane-Braket plugin <https://amazon-braket-pennylane-plugin-python.readthedocs.io/en/latest/>`__. | ||
| See the | ||
| `Catalyst configuration file <https://github.com/PennyLaneAI/catalyst/blob/main/runtime/lib/backend/openqasm/braket_local_qubit.toml>`__ | ||
| for natively supported instructions. | ||
|
|
||
| * - ``qrack.simulator`` | ||
|
|
||
| - `Qrack <https://github.com/unitaryfund/qrack>`__ is a GPU-accelerated quantum computer | ||
| simulator with many novel optimizations including hybrid stabilizer simulation. To use this | ||
| device with Catalyst, make sure to install the | ||
| `PennyLane-Qrack plugin <https://pennylane-qrack.readthedocs.io/en/latest/>`__, and check out | ||
| the `QJIT compilation with Qrack and Catalyst tutorial <https://pennylane.ai/qml/demos/qrack/>`__. | ||
|
|
||
| See the `Catalyst configuration file <https://github.com/unitaryfund/pennylane-qrack/blob/master/pennylane_qrack/QrackDeviceConfig.toml>`__ | ||
| for natively supported instructions. | ||
|
|
||
| * - ``oqc.cloud`` | ||
|
|
||
| - Execute on `Oxford Quantum Circuits (OQC) <https://www.oqc.tech/>`__ superconducting hardware, | ||
| via `OQC Cloud <https://docs.oqc.app>`__. To use OQC Cloud with Catalyst, simply `install the | ||
| client <https://docs.oqc.app/installation.html>`__, ensure your credentials are set as | ||
| environment variables, and use the ``backend`` argument to specify the OQC backend to use: | ||
|
|
||
| .. code-block:: python | ||
| import os | ||
| os.environ["OQC_EMAIL"] = "your_email" | ||
| os.environ["OQC_PASSWORD"] = "your_password" | ||
| os.environ["OQC_URL"] = "oqc_url" | ||
| dev = qml.device("oqc.cloud", backend="lucy", shots=2012, wires=2) | ||
| See the `Catalyst configuration file <https://github.com/PennyLaneAI/catalyst/blob/main/frontend/catalyst/third_party/oqc/src/oqc.toml>`__ | ||
| for natively supported instructions. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters