Skip to content

Commit

Permalink
docs: Add docs for job examples (#148)
Browse files Browse the repository at this point in the history
* docs: Add docs for job examples

* address comments
  • Loading branch information
kshitijc authored Nov 17, 2021
1 parent 08ebaa5 commit f307931
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/examples-hybrid-jobs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
################################
Amazon Braket Hybrid Jobs
################################

Learn more about hybrid jobs on Amazon Braket.

.. toctree::
:maxdepth: 2

**************************
`Getting Started <https://github.com/aws/amazon-braket-examples/blob/main/examples/hybrid_jobs/0_Getting_started/Getting_started.ipynb>`_
**************************

This tutorial shows how to run your first Amazon Braket Hybrid Job.

**************************
`Hyperparameter Tuning <https://github.com/aws/amazon-braket-examples/blob/main/examples/hybrid_jobs/1_Hyperparameter_tuning/Hyperparameter_tuning.ipynb>`_
**************************

This notebook demonstrates a typical quantum machine learning workflow, including uploading data, monitoring training, and tuning hyperparameters.

**************************
`Using Pennylane with Braket Jobs <https://github.com/aws/amazon-braket-examples/blob/main/examples/hybrid_jobs/2_Using_PennyLane_with_Braket_Jobs/Using_PennyLane_with_Braket_Jobs.ipynb>`_
**************************

In this tutorial, we use PennyLane within Amazon Braket Hybrid Jobs to run the Quantum Approximate Optimization Algorithm (QAOA) on a Max-Cut problem.

**************************
`Bring your own container <https://github.com/aws/amazon-braket-examples/blob/main/examples/hybrid_jobs/3_Bring_your_own_container/bring_your_own_container.ipynb>`_
**************************

Amazon Braket has pre-configured containers for executing Amazon Braket Hybrid Jobs, which are sufficient for many use cases involving the Braket SDK and PennyLane.
However, if we want to use custom packages outside the scope of pre-configured containers, we have the ability to supply a custom-built container. In this tutorial, we show how to use Braket Hybrid Jobs to train a quantum machine learning model using BYOC (Bring Your Own Container).
1 change: 1 addition & 0 deletions doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ https://github.com/aws/amazon-braket-examples.
examples-hybrid-quantum.rst
examples-ml-pennylane.rst
examples-quantum-annealing-dwave.rst
examples-hybrid-jobs.rst


0 comments on commit f307931

Please sign in to comment.