Skip to content

Commit

Permalink
Update GitHub URL paths to use amazon-braket (#132)
Browse files Browse the repository at this point in the history
Co-authored-by: Cody Wang <[email protected]>
Co-authored-by: Ashlyn Hanson <[email protected]>
  • Loading branch information
3 people authored Feb 16, 2024
1 parent 6815736 commit 139b890
Show file tree
Hide file tree
Showing 20 changed files with 34 additions and 34 deletions.
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating

#### General

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

#### Tests

Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Please read through this document before submitting any issues or pull requests
information to effectively respond to your bug report or contribution.

## Adding a New Algorithm
We expect algorithms to be built on top of the [Amazon Braket SDK](https://github.com/aws/amazon-braket-sdk-python) to provide a unified user experience and to give us a single contract to test against.
We expect algorithms to be built on top of the [Amazon Braket SDK](https://github.com/amazon-braket/amazon-braket-sdk-python) to provide a unified user experience and to give us a single contract to test against.

Please ensure that
1. Your algorithm is added as functional source code [here](https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms)
2. Add tests for your new code [here](https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/test/unit_tests/braket/experimental/algorithms)
3. You illustrate use of the algorithm in a simple python notebook [here](https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/notebooks)
1. Your algorithm is added as functional source code [here](https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms)
2. Add tests for your new code [here](https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/test/unit_tests/braket/experimental/algorithms)
3. You illustrate use of the algorithm in a simple python notebook [here](https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/notebooks)

## Reporting Bugs/Feature Requests

We welcome you to use the [GitHub issue tracker](https://github.com/aws-samples/amazon-braket-algorithm-library/issues) to report bugs or suggest features.
We welcome you to use the [GitHub issue tracker](https://github.com/amazon-braket/amazon-braket-algorithm-library/issues) to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
Expand Down Expand Up @@ -62,7 +62,7 @@ pip uninstall amazon-braket-algorithm-library -y
# Download the repo and install the changes that are to be tested
cd SageMaker/
rm -rf "Braket algorithms"
git clone https://github.com/aws-samples/amazon-braket-algorithm-library.git
git clone https://github.com/amazon-braket/amazon-braket-algorithm-library.git
cd amazon-braket-algorithm-library/
# This command is not needed if a contributor has not published a remote branch already.
git checkout <WORKING_BRANCH>
Expand Down Expand Up @@ -94,7 +94,7 @@ When you make a contribution please ensure that you:
-->
3. Only have Open Source licensed dependencies in your example.
4. Run your algorithm on a simulator and optionally on a QPU in your notebook.
5. Ensure that your example runs without issues on both a recent Braket Notebook Instance (create a new Braket Notebook Instance or restart one from Amazon Braket [in the console](https://docs.aws.amazon.com/braket/latest/developerguide/braket-get-started-create-notebook.html)) and locally, using our most [recently released Amazon Braket SDK version](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md#installing-the-amazon-braket-python-sdk). Run the entire notebook by clicking `Cells > Run All`, either in the console or locally, and confirm that every cell completes without error.
5. Ensure that your example runs without issues on both a recent Braket Notebook Instance (create a new Braket Notebook Instance or restart one from Amazon Braket [in the console](https://docs.aws.amazon.com/braket/latest/developerguide/braket-get-started-create-notebook.html)) and locally, using our most [recently released Amazon Braket SDK version](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/main/README.md#installing-the-amazon-braket-python-sdk). Run the entire notebook by clicking `Cells > Run All`, either in the console or locally, and confirm that every cell completes without error.

In addition we encourage re-use of existing examples but it is not required. If you see an opportunity to make use of existing modules,
feel free to do so. For instance if your example implementation requires Quantum Fourier Transform and you can use the existing
Expand All @@ -115,7 +115,7 @@ [email protected] with any additional questions or comments.


## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.


## Licensing
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Amazon Braket Algorithm Library
[![Build](https://github.com/aws-samples/amazon-braket-algorithm-library/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/aws-samples/amazon-braket-algorithm-library/actions/workflows/python-package.yml)
[![Build](https://github.com/amazon-braket/amazon-braket-algorithm-library/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/amazon-braket/amazon-braket-algorithm-library/actions/workflows/python-package.yml)

The Braket Algorithm Library provides Amazon Braket customers with pre-built implementations of prominent quantum algorithms and experimental workloads as ready-to-run example notebooks.

---
Currently, Braket algorithms are tested on Linux, Windows, and Mac.

Running notebooks locally requires additional dependencies located in [notebooks/textbook/requirements.txt](https://github.com/aws-samples/amazon-braket-algorithm-library/blob/main/notebooks/textbook/requirements.txt). See notebooks/textbook/README.md for more information.
Running notebooks locally requires additional dependencies located in [notebooks/textbook/requirements.txt](https://github.com/amazon-braket/amazon-braket-algorithm-library/blob/main/notebooks/textbook/requirements.txt). See notebooks/textbook/README.md for more information.

---
## <a name="install">Installing the Amazon Braket Algorithm Library</a>
The Amazon Braket Algorithm Library can be installed from source by cloning this repository and running a pip install command in the root directory of the repository.

```bash
git clone https://github.com/aws-samples/amazon-braket-algorithm-library.git
git clone https://github.com/amazon-braket/amazon-braket-algorithm-library.git
cd amazon-braket-algorithm-library
pip install .
```
Expand All @@ -35,13 +35,13 @@ If you are new to Amazon Braket, onboard to the service and create the resources
### Issues and Bug Reports

If you encounter bugs or face issues while using the algorithm library, please let us know by posting
the issue on our [Github issue tracker](https://github.com/aws-samples/amazon-braket-algorithm-library/issues).
the issue on our [GitHub issue tracker](https://github.com/amazon-braket/amazon-braket-algorithm-library/issues).
For other issues or general questions, please ask on the [Quantum Computing Stack Exchange](https://quantumcomputing.stackexchange.com/questions/ask) and add the tag amazon-braket.

### Feedback and Feature Requests

If you have feedback or features that you would like to see on Amazon Braket, we would love to hear from you!
[Github issues](https://github.com/aws-samples/amazon-braket-algorithm-library/issues) is our preferred mechanism for collecting feedback and feature requests, allowing other users
[GitHub issues](https://github.com/amazon-braket/amazon-braket-algorithm-library/issues) is our preferred mechanism for collecting feedback and feature requests, allowing other users
to engage in the conversation, and +1 issues to help drive priority.


Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Braket Algorithm Library provides Amazon Braket customers with pre-built imp

Currently, Braket algorithms are tested on Linux, Windows, and Mac.

Running notebooks locally requires additional dependencies located in notebooks/textbook/requirements.txt https://github.com/aws-samples/amazon-braket-algorithm-library/blob/main/notebooks/textbook/requirements.txt. See notebooks/textbook/README.md for more information.
Running notebooks locally requires additional dependencies located in notebooks/textbook/requirements.txt https://github.com/amazon-braket/amazon-braket-algorithm-library/blob/main/notebooks/textbook/requirements.txt. See notebooks/textbook/README.md for more information.
__________________

* :doc:`_apidoc/modules`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Quantum Computing Quantum Monte Carlo: ground state energy of H$_2$\n",
"\n",
"In this notebook, we demonstrate how to augment classical QMC calculations using quantum computers (QC) using auxiliary-field QMC (AFQMC) [1]. Compared to the variational quantum eigensolver (VQE) [2], a popular quantum algorithm for solving the electronic structure problem, QC‑AFQMC does not require an expensive optimization loop. The circuit depth of both methods is similar. This notebook presents an example AFQMC calculation to find the ground state of H$_2$ molecule. The code can be run on both classical simulators and quantum computers. For more details about the algorithm, see this [example notebook](https://github.com/aws/amazon-braket-examples/blob/feature/quantum-monte-carlo/examples/hybrid_quantum_algorithms/Quantum_Monte_Carlo_Chemistry/Quantum_Monte_Carlo_Chemistry.ipynb) in Amazon Braket Examples.\n",
"In this notebook, we demonstrate how to augment classical QMC calculations using quantum computers (QC) using auxiliary-field QMC (AFQMC) [1]. Compared to the variational quantum eigensolver (VQE) [2], a popular quantum algorithm for solving the electronic structure problem, QC‑AFQMC does not require an expensive optimization loop. The circuit depth of both methods is similar. This notebook presents an example AFQMC calculation to find the ground state of H$_2$ molecule. The code can be run on both classical simulators and quantum computers. For more details about the algorithm, see this [example notebook](https://github.com/amazon-braket/amazon-braket-examples/blob/feature/quantum-monte-carlo/examples/hybrid_quantum_algorithms/Quantum_Monte_Carlo_Chemistry/Quantum_Monte_Carlo_Chemistry.ipynb) in Amazon Braket Examples.\n",
"\n",
"\n",
"[1] Motta, Mario, and Shiwei Zhang. \"Ab initio computations of molecular systems by the auxiliary‐field quantum Monte Carlo method.\" [Wiley Interdisciplinary Reviews: Computational Molecular Science 8.5 (2018): e1364](https://doi.org/10.1002/wcms.1364).\n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/textbook/Simons_Algorithm.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"\n",
"[2] SIAM: [Original article](https://epubs.siam.org/doi/10.1137/S0097539796298637)\n",
"\n",
"[3] Amazon Braket's github repository: [Detailed example notebook](https://github.com/aws/amazon-braket-examples/blob/main/examples/advanced_circuits_algorithms/Simons_Algorithm/Simons_Algorithm.ipynb)"
"[3] Amazon Braket's GitHub repository: [Detailed example notebook](https://github.com/amazon-braket/amazon-braket-examples/blob/main/examples/advanced_circuits_algorithms/Simons_Algorithm/Simons_Algorithm.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
]
},
include_package_data=True,
url="https://github.com/aws-samples/amazon-braket-algorithm-library",
url="https://github.com/amazon-braket/amazon-braket-algorithm-library",
author="Amazon Web Services",
description=(
"An open source library of quantum computing algorithms implemented on Amazon Braket"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Bell's Inequality shows that certain predictions of quantum mechanics cannot be
<!--
[metadata-name]: Violation of Bell's Inequality
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/bells_inequality
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/bells_inequality
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ The Bernstein-Vazirani algorithm is the first quantum algorithm that solves a pr
<!--
[metadata-name]: Bernstein-Vazirani Algorithm
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/bernstein_vazirani
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/bernstein_vazirani
-->
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ CHSH (Clauser, Horne, Shimony and Holt) inequality is one of the Bell's inequali

<!--
[metadata-name]: Violation of CHSH inequality
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/chsh_inequality
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/chsh_inequality
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ One of the first quantum algorithm’s developed by pioneers David Deutsch and R
<!--
[metadata-name]: Deutsch-Jozsa Algorithm
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/deutsch_jozsa
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/deutsch_jozsa
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Grover's algorithm is arguably one of the canonical quantum algorithms that kick
<!--
[metadata-name]: Grover's Search
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/grovers_search
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/grovers_search
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ The Quantum Approximate Optimization Algorithm (QAOA) belongs to the class of hy
<!--
[metadata-name]: Quantum Approximate Optimization Algorithm
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_approximate_optimization
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_approximate_optimization
-->

Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ The quantum circuit Born machine (QCBM) is a variational quantum algorithm used
<!--
[metadata-name]: Quantum Circuit Born Machine
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_circuit_born_machine
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_circuit_born_machine
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ The Quantum Fourier Transform (QFT) is an important subroutine to many quantum a
<!--
[metadata-name]: Quantum Fourier Transformation
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_fourier_transform
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_fourier_transform
-->

Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ The Quantum Phase Estimation algorithm is designed to estimate the eigenvalues o
<!--
[metadata-name]: Quantum Phase Estimation
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/blob/main/src/braket/experimental/algorithms/quantum_phase_estimation
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/blob/main/src/braket/experimental/algorithms/quantum_phase_estimation
-->
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ The quantum walk is very similar to the classical walk, where a walker observes
<!--
[metadata-name]: Quantum Walk
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_walk
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/quantum_walk
-->

2 changes: 1 addition & 1 deletion src/braket/experimental/algorithms/shors/shors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Shor's algorithm is used to find prime factors of an integer. On a quantum compu
<!--
[metadata-name]: Shor's Algorithm
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/blob/main/src/braket/experimental/algorithms/shors
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/blob/main/src/braket/experimental/algorithms/shors
-->
2 changes: 1 addition & 1 deletion src/braket/experimental/algorithms/simons/simons.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Simon's algorithm solves the problem of given a function f:{0,1}^n→{0,1}^n tha
<!--
[metadata-name]: Simon's Algorithm
[metadata-tags]: Textbook
[metadata-url]: https://github.com/aws-samples/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/simons
[metadata-url]: https://github.com/amazon-braket/amazon-braket-algorithm-library/tree/main/src/braket/experimental/algorithms/simons
-->
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ skip_install = true
deps =
flake8
flake8-rst-docstrings
git+https://github.com/aws/amazon-braket-build-tools.git
git+https://github.com/amazon-braket/amazon-braket-build-tools.git
commands =
flake8 {posargs}

Expand Down Expand Up @@ -98,4 +98,4 @@ commands =
[test-deps]
deps =
# If you need to test on a certain branch, add @<branch-name> after .git
git+https://github.com/aws/amazon-braket-sdk-python.git
git+https://github.com/amazon-braket/amazon-braket-sdk-python.git

0 comments on commit 139b890

Please sign in to comment.