diff --git a/README.md b/README.md index 79342633..323d782e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ **DO NOT SHARE OR TALK ABOUT THE CONTENTS OF THIS LIBRARY per the Amazon Beta NDA you signed.** -Amazon Braket Python IR is an open source library that contains all the 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. +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 @@ -9,19 +12,19 @@ Amazon Braket Python IR is an open source library that contains all the intermed ### Steps ```bash - git clone https://github.com/aws/braket-python-ir.git --branch stable/latest - pip install -e braket-python-ir + git clone https://github.com/aws/amazon-braket-schemas-python.git + pip install -e amazon-braket-schemas-python ``` To install test dependencies for running tests locally run: ```bash - pip install -e "braket-python-ir[test]" + pip install -e "amazon-braket-schemas-python[test]" ``` -You can check your currently installed version of `braket-python-ir` with `pip show`: +You can check your currently installed version of `amazon-braket-schemas-python` with `pip show`: ```bash -pip show braket-python-ir +pip show amazon-braket-schemas-python ``` or alternatively from within Python: @@ -199,7 +202,7 @@ Then open `BRAKET_IR_ROOT/build/documentation/html/index.html` in a browser to v Make sure to install test dependencies first: ```bash -pip install -e "braket-python-ir[test]" +pip install -e "amazon-braket-schemas-python[test]" ``` To run the unit tests: diff --git a/doc/Makefile b/doc/Makefile index 72f1121c..988ea483 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = python -msphinx -SPHINXPROJ = braket-ir +SPHINXPROJ = amazon-braket-schemas SOURCEDIR = . BUILDDIR = ../build/documentation diff --git a/doc/conf.py b/doc/conf.py index 25bdd4b9..46d1b66e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -4,7 +4,7 @@ import pkg_resources # Sphinx configuration below. -project = "braket-ir" +project = "amazon-braket-schemas" version = pkg_resources.require(project)[0].version release = version copyright = "{}, Amazon.com".format(datetime.datetime.now().year) diff --git a/doc/index.rst b/doc/index.rst index c26692c1..074485bc 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,13 @@ -Amazon Braket Python IR +Amazon Braket Python Schemas ==================== -Amazon Braket Python IR is an open source library that contains all the 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. +Amazon Braket Python Schemas is an open source library that contains the schemas for Braket, including: -Here you'll find an overview and API documentation for Amazon Braket Python IR. The project homepage is in GitHub, https://github.com/aws/braket-python-ir, where you can find the source and installation instructions for the library. +* 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 + +Here you'll find an overview and API documentation for Amazon Braket Python Schemas. The project homepage is in GitHub, https://github.com/aws/amazon-braket-schemas-python, where you can find the source and installation instructions for the library. Indices and tables __________________ diff --git a/setup.py b/setup.py index fa8bafdb..8439821d 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ version = f.readlines()[-1].split()[-1].strip("\"'") setup( - name="braket-ir", + name="amazon-braket-schemas", version=version, license="Apache License 2.0", python_requires=">= 3.7", diff --git a/src/braket/task_result/rigetti_metadata_v1.py b/src/braket/task_result/rigetti_metadata_v1.py index ab3a2593..71b997aa 100644 --- a/src/braket/task_result/rigetti_metadata_v1.py +++ b/src/braket/task_result/rigetti_metadata_v1.py @@ -20,7 +20,7 @@ class NativeQuilMetadata(BaseModel): """ - Schema to hold native quil metadata returned by + Schema to hold native quil metadata returned by Rigetti after compilation. Examples: @@ -49,7 +49,8 @@ class RigettiMetadata(BraketSchemaBase): The Rigetti metadata result schema. Attributes: - braketSchemaHeader (BraketSchemaHeader): Schema header. Users do not need to set this value. Only default is allowed. + braketSchemaHeader (BraketSchemaHeader): Schema header. + Users do not need to set this value. Only default is allowed. nativeQuilMetadata (NativeQuilMetadata) program (str): The compiled program executed on the QPU