Amazon Braket Python Schemas
Amazon Braket Python Schemas is an open source library that contains the schemas for Braket, including:
- intermediate representations (IR) for Amazon Braket quantum tasks and offers serialization and deserialization of those IR payloads. Think of the IR as the contract between the Amazon Braket SDK and Amazon Braket API for quantum programs.
- schemas for the S3 results of each quantum task
- schemas for the device capabilities of each device
Installation
Prerequisites
- Python 3.11+
Steps
The preferred way to get Amazon Braket Python Schemas is by installing the Amazon Braket Python SDK, which will pull in the schemas. Follow the instructions in the README for setup.
However, if you only want to use the schemas, it can be installed on its own as follows:
pip install amazon-braket-schemas
You can install from source by cloning this repository and running a pip install command in the root directory of the repository:
git clone https://github.com/amazon-braket/amazon-braket-schemas-python.git
cd amazon-braket-schemas-python
pip install .
You can check your currently installed version of amazon-braket-schemas with pip show:
pip show amazon-braket-schemas
or alternatively from within Python:
>>> import braket._schemas as braket_schemas
>>> braket_schemas.__version__
Usage
OpenQASM (Open Quantum Assembly Language) is one type of IR. See below for its usage.
Serializing python structures
from braket.ir.openqasm import Program as OpenQASMProgram
program = OpenQASMProgram(source="OPENQASM 3.0; cnot $0, $1;")
print(program.json(indent=2))
"""
{
"braketSchemaHeader": {
"name": "braket.ir.openqasm.program",
"version": "1"
},
"source": "OPENQASM 3.0; cnot $0, $1;",
"inputs": null
}
"""
Deserializing into python structures
from braket.ir.openqasm import Program as OpenQASMProgram
openqasm_string = """
{
"braketSchemaHeader": {
"name": "braket.ir.openqasm.program",
"version": "1"
},
"source": "OPENQASM 3.0; cnot $0, $1;"
}"""
program = OpenQASMProgram.parse_raw(openqasm_string)
print(program)
"""
braketSchemaHeader=BraketSchemaHeader(name='braket.ir.openqasm.program', version='1') source='OPENQASM 3.0; cnot $0, $1;' inputs=None
"""
Documentation
Detailed documentation, including the API reference, can be found on Read the Docs.
You can also generate the docs from source. First, install tox:
pip install tox
To build the Sphinx docs, run the following command in the root repo directory:
tox -e docs
You can then find the generated HTML files in build/documentation/html.
Testing
Make sure to install test dependencies first:
pip install -e "amazon-braket-schemas-python[test]"
To run the unit tests:
tox -e unit-tests
You can also pass in various pytest arguments to run selected tests:
tox -e unit-tests -- your-arguments
To run linters and doc generators and unit tests:
tox
For more information, please see pytest usage.
License
This project is licensed under the Apache-2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file amazon_braket_schemas-1.32.1.post0.tar.gz.
File metadata
- Download URL: amazon_braket_schemas-1.32.1.post0.tar.gz
- Upload date:
- Size: 60.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4659c1b7b2f392ac74baf32835b34bdcfc7fc2a7d4e06c2121dc436527ea3694
|
|
| MD5 |
d3c57110d63ab6fa4556d5263f4f3ccb
|
|
| BLAKE2b-256 |
839f33a5e8c8acba21741538795ed23f3d564606268143d726e0b9227826250f
|
Provenance
The following attestation bundles were made for amazon_braket_schemas-1.32.1.post0.tar.gz:
Publisher:
publish-to-pypi.yml on amazon-braket/amazon-braket-schemas-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
amazon_braket_schemas-1.32.1.post0.tar.gz -
Subject digest:
4659c1b7b2f392ac74baf32835b34bdcfc7fc2a7d4e06c2121dc436527ea3694 - Sigstore transparency entry: 2687988295
- Sigstore integration time:
-
Permalink:
amazon-braket/amazon-braket-schemas-python@7b7dd0b21fa11b2dbdfb3c750bc8c8c2dd4c4df3 -
Branch / Tag:
refs/tags/v1.32.1.post0 - Owner: https://github.com/amazon-braket
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@7b7dd0b21fa11b2dbdfb3c750bc8c8c2dd4c4df3 -
Trigger Event:
release
-
Statement type:
File details
Details for the file amazon_braket_schemas-1.32.1.post0-py3-none-any.whl.
File metadata
- Download URL: amazon_braket_schemas-1.32.1.post0-py3-none-any.whl
- Upload date:
- Size: 153.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eae8c404ee21da8c01e18cc242a90032b0ed4fb3b104671ac3a05a8dee693d51
|
|
| MD5 |
848e420856b9995b7ebdd4ea728ee8ba
|
|
| BLAKE2b-256 |
4ab2ae8fb926e139b15d78c12f498a76cfc1b1bf3374c9dcf9c6e927d4f91e40
|
Provenance
The following attestation bundles were made for amazon_braket_schemas-1.32.1.post0-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on amazon-braket/amazon-braket-schemas-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
amazon_braket_schemas-1.32.1.post0-py3-none-any.whl -
Subject digest:
eae8c404ee21da8c01e18cc242a90032b0ed4fb3b104671ac3a05a8dee693d51 - Sigstore transparency entry: 2687988378
- Sigstore integration time:
-
Permalink:
amazon-braket/amazon-braket-schemas-python@7b7dd0b21fa11b2dbdfb3c750bc8c8c2dd4c4df3 -
Branch / Tag:
refs/tags/v1.32.1.post0 - Owner: https://github.com/amazon-braket
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@7b7dd0b21fa11b2dbdfb3c750bc8c8c2dd4c4df3 -
Trigger Event:
release
-
Statement type:
