Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modifications per repository name change #26

Merged
merged 1 commit into from
Jul 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
10 changes: 7 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -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
__________________
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 3 additions & 2 deletions src/braket/task_result/rigetti_metadata_v1.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand Down