doc: add Braket SDK cheat sheet#1280
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1280 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 169 170 +1
Lines 10963 11011 +48
Branches 1412 1413 +1
=========================================
+ Hits 10963 11011 +48 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Please add a script that generates the AI-cheat sheet and build the webpage so we can test it locally. |
|
Sure thanks for the review will add that too |
|
@peterkomar-aws I have added the requested AI cheat sheet generation script and updated the README with local build/testing instructions. I also added a Please review it when you get a chance. |
|
@peterkomar-aws I have added all the requirements. Please review it when you get a chance. |
Summary
This PR updates and completes the Amazon Braket SDK cheat sheet for #1255.
I focused on making the cheat sheet accurate against the current SDK, compact in the existing two-column style, and easier to extend with the missing sections requested in the issue.
Changes
Added new cheat sheet sections for:
Updated the Hybrid Jobs section to include the current hybrid job decorator workflow.
Refreshed outdated snippets across existing sections, including:
Updated
blocks.ymlso the new sections are included in the rendered cheat sheet.I based this on the existing draft cheat sheet structure from feat: publish a cheat sheet via github pages #995, but kept this PR focused on the English SDK cheat sheet and contribution notes. I did not include the incomplete French translation files from the draft because the issue requirements focus on updating SDK content and adding the requested missing feature sections.
Verification
I reviewed the updated snippets against the Amazon Braket Python SDK API reference and the current repository source where needed.
For snippets that can run locally without AWS credentials, I ran local verification checks, including imports and executable examples for:
LocalSimulatorProgramSetCircuitBindingParameterSetsDevices.Amazon.SV1For AWS-dependent snippets, such as AWS devices, reservations, and hybrid jobs, I avoided submitting cloud tasks. Instead, I verified the relevant imports and checked public method signatures locally to confirm that the documented parameters are supported by the installed SDK.
Notes
Some examples intentionally use placeholders such as
device_arn,reservation_arn, andcircuitbecause executing those snippets requires AWS credentials, a configured AWS region, and valid Braket resources.AI disclosure
I used ChatGPT to review documentation and identify commands to verify imports/signatures locally. I manually reviewed the suggested changes, checked the relevant SDK references, ran the local verification steps, and edited the final snippets before submitting.
@peterkomar-aws , could you kindly review this PR when you get a chance? I would appreciate any suggestions on the section ordering, snippet style, or any SDK-specific wording that should be adjusted.