Skip to content

Commit

Permalink
documentation: updating README to remove private beta instructions (#130
Browse files Browse the repository at this point in the history
)

* Version bump

* documentation: examples updates
  • Loading branch information
avawang1 authored Aug 12, 2020
1 parent 9fba841 commit c13343e
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 266 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating

- [ ] I have read the [CONTRIBUTING](https://github.com/aws/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md) doc
- [ ] I used the commit message format described in [CONTRIBUTING](https://github.com/aws/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md#commit-your-change)
- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md) and [API docs](https://github.com/aws/amazon-braket-sdk-python#braket-python-sdk-api-reference-documentation) (if appropriate)
- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md) and [API docs](https://github.com/aws/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md#documentation-guidelines) (if appropriate)

#### Tests

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ For the rest of the message, use imperative style and keep things concise but in
### Send a Pull Request
GitHub provides additional document on [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/).
GitHub provides additional documentation on [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/).
Please remember to:
* Use commit messages (and PR titles) that follow the guidelines under [Commit Your Change](#commit-your-change).
Expand Down
302 changes: 43 additions & 259 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Amazon Braket (Private Beta) Python SDK
Amazon Braket Python SDK
=======================================

Amazon Braket Python SDK is an open source library for interacting with quantum devices on Amazon Braket (Private Beta).
Amazon Braket Python SDK is an open source library for interacting with quantum devices on Amazon Braket.

This documentation provides information about the Amazon Braket Python SDK API. For information about how to configure your environment to use the braket-python-sdk, please see the README in the GitHub repo for this project at https://github.com/aws/amazon-braket-sdk-python.

Expand Down
2 changes: 1 addition & 1 deletion examples/bell.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
aws_account_id = boto3.client("sts").get_caller_identity()["Account"]

device = AwsDevice("arn:aws:braket:::device/quantum-simulator/amazon/sv1")
s3_folder = (f"braket-output-{aws_account_id}", "folder-name")
s3_folder = (f"amazon-braket-output-{aws_account_id}", "folder-name")

# https://wikipedia.org/wiki/Bell_state
bell = Circuit().h(0).cnot(0, 1)
Expand Down
2 changes: 1 addition & 1 deletion examples/debug_bell.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
aws_account_id = boto3.client("sts").get_caller_identity()["Account"]

device = AwsDevice("arn:aws:braket:::device/quantum-simulator/amazon/sv1")
s3_folder = (f"braket-output-{aws_account_id}", "folder-name")
s3_folder = (f"amazon-braket-output-{aws_account_id}", "folder-name")

bell = Circuit().h(0).cnot(0, 1)
# pass in logger to device.run, enabling debugging logs to print to console
Expand Down
2 changes: 1 addition & 1 deletion src/braket/_sdk/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
Version number (major.minor.patch[-label])
"""

__version__ = "0.6.0"
__version__ = "1.0.0"

0 comments on commit c13343e

Please sign in to comment.