Skip to main content

An open source library of quantum computing algorithms implemented on Amazon Braket

Project description

Amazon Braket Algorithm Library

Build Documentation Status

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.


Braket algorithms

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

Running notebooks locally requires additional dependencies located in notebooks/textbook/requirements.txt. See notebooks/textbook/README.md for more information.

Textbook algorithms Notebook References
Bell's Inequality Bells_Inequality.ipynb Bell1964, Greenberger1990
Bernstein–Vazirani Bernstein_Vazirani_Algorithm.ipynb Bernstein1997
CHSH Inequality CHSH_Inequality.ipynb Clauser1970
Deutsch-Jozsa Deutsch_Jozsa_Algorithm.ipynb Deutsch1992
Grover's Search Grovers_Search.ipynb Figgatt2017, Baker2019
QAOA Quantum_Approximate_Optimization_Algorithm.ipynb Farhi2014
Quantum Circuit Born Machine Quantum_Circuit_Born_Machine.ipynb Benedetti2019, Liu2018
QFT Quantum_Fourier_Transform.ipynb Coppersmith2002
QPE Quantum_Phase_Estimation_Algorithm.ipynb Kitaev1995
Quantum Walk Quantum_Walk.ipynb Childs2002
Shor's Shors_Algorithm.ipynb Shor1998
Simon's Simons_Algorithm.ipynb Simon1997
Advanced algorithms Notebook References
Quantum PCA Quantum_Principal_Component_Analysis.ipynb He2022
QMC Quantum_Computing_Quantum_Monte_Carlo.ipynb Motta2018, Peruzzo2014
Adaptive Shot Allocation 2_Adaptive_Shot_Allocation.ipynb Shlosberg2023
Auxiliary functions Notebook
Random circuit generator Random_Circuit.ipynb

Community repos

:warning: The following includes projects that are not provided by Amazon Braket. You are solely responsible for your use of those projects (including compliance with any applicable licenses and fitness of the project for your particular purpose).

Quantum algorithm implementations using Braket in other repos:

Algorithm Repo References Additional dependencies
Quantum Reinforcement Learning quantum-computing-exploration-for-drug-discovery-on-aws Learning Retrosynthetic Planning through Simulated Experience(2019) dependencies

Installing the Amazon Braket Algorithm Library

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.

git clone https://github.com/amazon-braket/amazon-braket-algorithm-library.git
cd amazon-braket-algorithm-library
pip install .

To run the notebook examples locally on your IDE, first, configure a profile to use your account to interact with AWS. To learn more, see Configure AWS CLI.

After you create a profile, use the following command to set the AWS_PROFILE so that all future commands can access your AWS account and resources.

export AWS_PROFILE=YOUR_PROFILE_NAME

Configure your AWS account with the resources necessary for Amazon Braket

If you are new to Amazon Braket, onboard to the service and create the resources necessary to use Amazon Braket using the AWS console.

Support

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.
For other issues or general questions, please ask on the Quantum Computing Stack Exchange 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 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.

License

This project is licensed under the Apache-2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amazon_braket_algorithm_library-1.7.3.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amazon_braket_algorithm_library-1.7.3-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file amazon_braket_algorithm_library-1.7.3.tar.gz.

File metadata

File hashes

Hashes for amazon_braket_algorithm_library-1.7.3.tar.gz
Algorithm Hash digest
SHA256 f08e8f947369586f0d3285591f5319923765d5a29d1ab3d8c58ee71ce77db1a9
MD5 97fc407d36fdfa75b045e315a62adf35
BLAKE2b-256 0b63523a59031fe0d830dbf40b806ce22ae17533a903a4314ad856dec942f119

See more details on using hashes here.

Provenance

The following attestation bundles were made for amazon_braket_algorithm_library-1.7.3.tar.gz:

Publisher: publish-to-pypi.yml on amazon-braket/amazon-braket-algorithm-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file amazon_braket_algorithm_library-1.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for amazon_braket_algorithm_library-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a4acae4bc41ce93635974fb2c69b64f709dba253b98cc2ba3520522449cf1f7d
MD5 552ff02503b35c7413087874f291ca16
BLAKE2b-256 e06582d3afec66d8b432da20100ee9731d20c315d5a8b53e7004cd066a2b3df4

See more details on using hashes here.

Provenance

The following attestation bundles were made for amazon_braket_algorithm_library-1.7.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on amazon-braket/amazon-braket-algorithm-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page