feature: Add support for jobs #287

kshitijc · 2021-11-29T18:33:39Z

Issue #, if available:

Description of changes:

Add support for Amazon Braket Hybrid Jobs.
Add default S3 buckets for quantum tasks.

Testing done:

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

I have read the CONTRIBUTING doc
I used the commit message format described in CONTRIBUTING
I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

I have added tests that prove my fix is effective or that my feature works (if appropriate)
I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

… range.

Co-authored-by: Aaron Berdy <[email protected]>

feature: add utility class for getting jobs metrics

Jobs Initial Commit

Futureproof parameters for PL version 0.19/0.20, and add comments

* make copy_aws_session public * Add docstring, make func non-static * change function name

…le (#140)

* infra: Pin docutils<0.18 in doc requirements (#283) docutils 0.18 was released on October 26, 2021, and with it came some [breaking changes](readthedocs/readthedocs.org#8616) for sphinx, and in turn [readthedocs builds](https://readthedocs.org/projects/amazon-braket-sdk-python/builds/15168485/). To keep doc builds working, docutils will be constrained to versions below 0.18. * prepare release v1.9.5.post0 * update development version to v1.9.6.dev0 Co-authored-by: Cody Wang <[email protected]> Co-authored-by: ci <ci>

* Add implementation * Modify logging, add tests * Remove comments * Fix some feedback * Modify exception handling, tests * Reformat * Fix test issues * Fix test issues * Try again * feature: validate job creation endpoints for correct region * remove print statement * remove redundant log statements * remove default bucket aws session region constraint * testing * remove validation and simplify * Remove not needed data from aws_session fixture * Add logger * reformat, add logger docstring * remove commented code * remove not needed fixtures * remove fixtures itself * remove s3_region and custom bucket mocks * remove codelocation fixture * remove caplogs, don't pass exception * use aws_session fixture instead of creating new mocks Co-authored-by: Viraj Chaudhari <[email protected]>

* Revert "fix: Change default execution role to Amazon Braket Service-linked role (#140)" This reverts commit 67f0a37. * fix: Use default roles created using the console

* docs: Add docs for job examples * address comments

…149)

* update ecr repo names to be prefixed with amazon-braket * expect amazon-braket- prefix for custom ecr images * add managed custom test case and clean up branches

fix: better exception handling for aws device

codecov · 2021-11-29T18:36:40Z

Codecov Report

Merging #287 (a55c294) into main (35e3ead) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##              main      #287     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files           43        63     +20     
  Lines         3102      4204   +1102     
  Branches       424       578    +154     
===========================================
+ Hits          3102      4204   +1102

Impacted Files	Coverage Δ
src/braket/aws/__init__.py	`100.00% <100.00%> (ø)`
src/braket/aws/aws_device.py	`100.00% <100.00%> (ø)`
src/braket/aws/aws_quantum_job.py	`100.00% <100.00%> (ø)`
src/braket/aws/aws_quantum_task.py	`100.00% <100.00%> (ø)`
src/braket/aws/aws_session.py	`100.00% <100.00%> (ø)`
src/braket/jobs/__init__.py	`100.00% <100.00%> (ø)`
src/braket/jobs/config.py	`100.00% <100.00%> (ø)`
src/braket/jobs/data_persistence.py	`100.00% <100.00%> (ø)`
src/braket/jobs/image_uris.py	`100.00% <100.00%> (ø)`
src/braket/jobs/local/__init__.py	`100.00% <100.00%> (ø)`
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 35e3ead...a55c294. Read the comment docs.

Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]>

* infra: Pin docutils<0.18 in doc requirements (#283) docutils 0.18 was released on October 26, 2021, and with it came some [breaking changes](readthedocs/readthedocs.org#8616) for sphinx, and in turn [readthedocs builds](https://readthedocs.org/projects/amazon-braket-sdk-python/builds/15168485/). To keep doc builds working, docutils will be constrained to versions below 0.18. * prepare release v1.9.5.post0 * update development version to v1.9.6.dev0 * feature: Add support for jobs (#287) Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> * fix: Skip jobs integration tests (#288) * prepare release v1.10.0 * update development version to v1.10.1.dev0 * feature: Adding integration tests for DM1 (#286) * feature: Adding integration tests for DM1 * Moved many_layers to test_quantum_task * formatting changes only Co-authored-by: Cody Wang <[email protected]> * prepare release v1.11.0 * update development version to v1.11.1.dev0 * fix: remove extraneous reference from local job container setup (#292) * prepare release v1.11.1 * update development version to v1.11.2.dev0 * feature: optimize IAM role retrieval (#299) * fix: Enable jobs integration tests (#289) * feature: Added is_available property to AwsDevice (#290) Added is_available property to AwsDevice that parses the availability window and current device status to return a boolean flag if the device is currently available. * prepare release v1.12.0 * update development version to v1.12.1.dev0 * feature: added controlled-sqrt-not gate (#297) * feature: added controlled-sqrt-not gate This makes certain circuits, like CHSH, more straightforward. This commit works in line with the following branches (also committed, separately): https://github.com/unprovable/amazon-braket-schemas-python.git@ctrl-v-gate https://github.com/unprovable/amazon-braket-default-simulator-python.git@ctrl-v-gate * fix: ran tox linters * fix: reverted tox.ini Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Cody Wang <[email protected]> * prepare release v1.13.0 * update development version to v1.13.1.dev0 * feature: adding TwoQubitPauliChannel (#300) * prepare release v1.14.0 * update development version to v1.14.1.dev0 Co-authored-by: Cody Wang <[email protected]> Co-authored-by: ci <ci> Co-authored-by: Kshitij Chhabra <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> Co-authored-by: Jacob Feldman <[email protected]> Co-authored-by: Mark Sweat <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: mbeach-aws <[email protected]>

* infra: Pin docutils<0.18 in doc requirements (#283) docutils 0.18 was released on October 26, 2021, and with it came some [breaking changes](readthedocs/readthedocs.org#8616) for sphinx, and in turn [readthedocs builds](https://readthedocs.org/projects/amazon-braket-sdk-python/builds/15168485/). To keep doc builds working, docutils will be constrained to versions below 0.18. * prepare release v1.9.5.post0 * update development version to v1.9.6.dev0 * feature: Add support for jobs (#287) Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> * fix: Skip jobs integration tests (#288) * prepare release v1.10.0 * update development version to v1.10.1.dev0 * feature: Adding integration tests for DM1 (#286) * feature: Adding integration tests for DM1 * Moved many_layers to test_quantum_task * formatting changes only Co-authored-by: Cody Wang <[email protected]> * prepare release v1.11.0 * update development version to v1.11.1.dev0 * fix: remove extraneous reference from local job container setup (#292) * prepare release v1.11.1 * update development version to v1.11.2.dev0 * feature: optimize IAM role retrieval (#299) * fix: Enable jobs integration tests (#289) * feature: Added is_available property to AwsDevice (#290) Added is_available property to AwsDevice that parses the availability window and current device status to return a boolean flag if the device is currently available. * prepare release v1.12.0 * update development version to v1.12.1.dev0 * feature: added controlled-sqrt-not gate (#297) * feature: added controlled-sqrt-not gate This makes certain circuits, like CHSH, more straightforward. This commit works in line with the following branches (also committed, separately): https://github.com/unprovable/amazon-braket-schemas-python.git@ctrl-v-gate https://github.com/unprovable/amazon-braket-default-simulator-python.git@ctrl-v-gate * fix: ran tox linters * fix: reverted tox.ini Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Cody Wang <[email protected]> * prepare release v1.13.0 * update development version to v1.13.1.dev0 * feature: adding TwoQubitPauliChannel (#300) * prepare release v1.14.0 * update development version to v1.14.1.dev0 * documentation: fix documentation on environment variable to match the code. (#302) * prepare release v1.14.0.post0 * update development version to v1.14.1.dev0 * feat: Update region switching for regional device arns (#169) (#303) * prepare release v1.15.0 * update development version to v1.15.1.dev0 Co-authored-by: Cody Wang <[email protected]> Co-authored-by: ci <ci> Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> Co-authored-by: Jacob Feldman <[email protected]> Co-authored-by: Mark Sweat <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: mbeach-aws <[email protected]> Co-authored-by: Yiheng Duan <[email protected]>

* Added integration tests and LHR region to device configuration (#174) * fix: Add LHR to the list of device regions * test updates * fix: Add integration tests * formatting changes * fix: Return DiGraph for device.topology_graph (#175) * sync: Merge from public repository (#176) * infra: Pin docutils<0.18 in doc requirements (#283) docutils 0.18 was released on October 26, 2021, and with it came some [breaking changes](readthedocs/readthedocs.org#8616) for sphinx, and in turn [readthedocs builds](https://readthedocs.org/projects/amazon-braket-sdk-python/builds/15168485/). To keep doc builds working, docutils will be constrained to versions below 0.18. * prepare release v1.9.5.post0 * update development version to v1.9.6.dev0 * feature: Add support for jobs (#287) Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> * fix: Skip jobs integration tests (#288) * prepare release v1.10.0 * update development version to v1.10.1.dev0 * feature: Adding integration tests for DM1 (#286) * feature: Adding integration tests for DM1 * Moved many_layers to test_quantum_task * formatting changes only Co-authored-by: Cody Wang <[email protected]> * prepare release v1.11.0 * update development version to v1.11.1.dev0 * fix: remove extraneous reference from local job container setup (#292) * prepare release v1.11.1 * update development version to v1.11.2.dev0 * feature: optimize IAM role retrieval (#299) * fix: Enable jobs integration tests (#289) * feature: Added is_available property to AwsDevice (#290) Added is_available property to AwsDevice that parses the availability window and current device status to return a boolean flag if the device is currently available. * prepare release v1.12.0 * update development version to v1.12.1.dev0 * feature: added controlled-sqrt-not gate (#297) * feature: added controlled-sqrt-not gate This makes certain circuits, like CHSH, more straightforward. This commit works in line with the following branches (also committed, separately): https://github.com/unprovable/amazon-braket-schemas-python.git@ctrl-v-gate https://github.com/unprovable/amazon-braket-default-simulator-python.git@ctrl-v-gate * fix: ran tox linters * fix: reverted tox.ini Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Cody Wang <[email protected]> * prepare release v1.13.0 * update development version to v1.13.1.dev0 * feature: adding TwoQubitPauliChannel (#300) * prepare release v1.14.0 * update development version to v1.14.1.dev0 * documentation: fix documentation on environment variable to match the code. (#302) * prepare release v1.14.0.post0 * update development version to v1.14.1.dev0 * feat: Update region switching for regional device arns (#169) (#303) * prepare release v1.15.0 * update development version to v1.15.1.dev0 Co-authored-by: Cody Wang <[email protected]> Co-authored-by: ci <ci> Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> Co-authored-by: Jacob Feldman <[email protected]> Co-authored-by: Mark Sweat <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: mbeach-aws <[email protected]> Co-authored-by: Yiheng Duan <[email protected]> Co-authored-by: Cody Wang <[email protected]> Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Milan Krneta <[email protected]> Co-authored-by: Aaron Berdy <[email protected]> Co-authored-by: Lin <[email protected]> Co-authored-by: Roald Bradley Severtson <[email protected]> Co-authored-by: Christian Madsen <[email protected]> Co-authored-by: Jacob Feldman <[email protected]> Co-authored-by: Mark Sweat <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: Mark C <[email protected]> Co-authored-by: mbeach-aws <[email protected]> Co-authored-by: Yiheng Duan <[email protected]>

virajvchaudhari and others added 30 commits June 15, 2021 13:19

Jobs Initial Commit

d909ceb

Address Suggestions

9403ca0

Remove create job from aws_device

af783d0

Fix formatting

eb2957a

feature: add utility class for getting jobs metrics

7b0a9cd

feature: Code structure changes, docstrings fix

198d589

Remove implementation, duplicate content

870bbbd

Address suggestions

a228ca9

cfix default_bucket comment

ee9b682

Add copyright notice

c5b094f

incorporating feedback.

b18a202

Modifying the doc for returning the CW client, and updating copyright…

9b9c059

… range.

Forgot two copyright notices.

5f02948

Remove year from copyright content

bf4e211

Co-authored-by: Aaron Berdy <[email protected]>

Update PersistedJobData format

de51439

More fixes per PR comments.

cbae744

Adding a metrics fetcher that gets logs directly from CloudWatch logs.

345ae05

Updating braket jobs log group name.

a352320

Fixing comment in one of the test cases.

6e5b248

Fix defaults, Enums, comments

41c3acf

Merge pull request #2 from aws/jobmetrics

f427f08

feature: add utility class for getting jobs metrics

Fix comments, update jobdataformat enum

e0751c2

Merge branch 'main' into jobs

2dbc193

Handle imports

22cf0a7

Fix TypeError

ed419fd

Add TODO for metrics

c31b29d

feature: Jobs Skeleton

9c2d694

Jobs Initial Commit

feature: creating hybrid jobs from the Braket SDK

4d1d132

whitepace

7484311

some refactors mostly

06607f9

licedric and others added 20 commits November 10, 2021 13:43

Merge pull request #126 from aws/pl-grad-update

bb5ddc3

Futureproof parameters for PL version 0.19/0.20, and add comments

move & make copy_aws_session public (#146)

4643bc7

* make copy_aws_session public * Add docstring, make func non-static * change function name

fix: Change default execution role to Amazon Braket Service-linked ro…

67f0a37

…le (#140)

Track default bucket (#147)

d5a458f

fix(jobs): updating the additional library path. (#154)

31baf6e

update references to aspen-9 (#145)

bec68e3

fix: Update to use default roles created using the console (#155)

08ebaa5

* Revert "fix: Change default execution role to Amazon Braket Service-linked role (#140)" This reverts commit 67f0a37. * fix: Use default roles created using the console

docs: Add docs for job examples (#148)

f307931

* docs: Add docs for job examples * address comments

fix: Remove jobs examples since they now reside in the examples repo (#…

5b4d029

…149)

fix: Update the prefix to use for default jobs role (#158)

9c464e3

Remove remaining old example file (#160)

7c9812b

update ecr repo names to be prefixed with amazon-braket (#159)

23940eb

* update ecr repo names to be prefixed with amazon-braket * expect amazon-braket- prefix for custom ecr images * add managed custom test case and clean up branches

feature: hybrid job example (#157)

7a2c933

Aws device fix (#161)

a90cf35

fix: better exception handling for aws device

resolve integ test todos (#156)

79521d2

fix: Remove CI updates for staging repo (#151)

23b4dbc

Merge remote-tracking branch 'staging/main' into jobs_release

cef8342

fix: Update dependencies for github action tests

a55c294

kshitijc requested a review from a team as a code owner November 29, 2021 18:33

christianbmadsen approved these changes Nov 29, 2021

View reviewed changes

kshitijc merged commit 92b9001 into main Nov 29, 2021

kshitijc deleted the jobs_release branch November 29, 2021 18:42

laurencap added a commit to laurencap/amazon-braket-sdk-python that referenced this pull request Jul 5, 2023

Increase program test coverage (amazon-braket#287)

5c3abf9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Add support for jobs #287

feature: Add support for jobs #287

kshitijc commented Nov 29, 2021

codecov bot commented Nov 29, 2021 •

edited

Loading

feature: Add support for jobs #287

feature: Add support for jobs #287

Conversation

kshitijc commented Nov 29, 2021

Merge Checklist

General

Tests

codecov bot commented Nov 29, 2021 • edited Loading

Codecov Report

codecov bot commented Nov 29, 2021 •

edited

Loading