-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feature: Support for Braket Direct Reservations #87
Merged
kshyatt-aws
merged 19 commits into
amazon-braket:ksh/feature_bump
from
Fe-r-oz:DirectReservation
Aug 28, 2024
Merged
Changes from 6 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
b50615f
[Feature]: Support for Braket Direct reservations
42a5075
[Feature]: Support for Braket Direct reservations - adding docstrings…
c6a2bb3
[Feature]: Support for Braket Direct reservations - minor cleanup
c5c7254
[Feature]: Support for Braket Direct reservations - Adding more tests
4365624
[Feature]: Support for Braket Direct reservations - Final Polish
16b0d90
[Feature]: Support for Braket Direct reservations - Improving Indenta…
082ece3
[Feature]: Support for Braket Direct reservations - codereview
3db5912
[Feature]: Support for Braket Direct reservations - codereview
b67791c
[Feature]: Support for Braket Direct reservations - codereview
e127c8e
[Feature]: Support for Braket Direct reservations - codereview sugges…
815bf29
[Feature]: Support for Braket Direct reservations - formatting
5b22d5a
[Feature]: Support for Braket Direct reservations - formatting
1b2b572
Adding codereview suggestions
8d73982
Minor Formatting
9d0d8af
Minor Formatting
7fa635a
adding direct reservation details in docstring
226c0da
Minor formatting and cleanup
04a5253
CI documentation fix
0aef482
Merge branch 'amazon-braket:main' into DirectReservation
Fe-r-oz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -336,3 +336,66 @@ function get_devices(; arns::Vector{String}=String[], names::Vector{String}=Stri | |
end | ||
return sort(collect(values(device_map)), by=(x->getproperty(x, Symbol("_"*order_by)))) | ||
end | ||
|
||
""" | ||
DirectReservation(device::Union{Device, String, Nothing}, reservation_arn::Union{String, Nothing}) | ||
|
||
A context manager that adjusts AwsQuantumTasks generated within the context to utilize a reservation ARN | ||
for all tasks targeting the designated device. Notably, this manager permits only one reservation | ||
at a time. | ||
|
||
[Reservations](https://docs.aws.amazon.com/braket/latest/developerguide/braket-reservations.html) | ||
are specific to AWS accounts and devices. Only the AWS account that initiated the reservation | ||
can utilize the reservation ARN. Moreover, the reservation ARN is solely valid on the | ||
reserved device within the specified start and end times. | ||
|
||
Arguments: | ||
- device (Device | str | Nothing): The Braket device for which you possess a reservation ARN, or | ||
Fe-r-oz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
alternatively, the device ARN. | ||
- reservation_arn (str | Nothing): The Braket Direct reservation ARN to be implemented for all | ||
quantum tasks executed within the contex | ||
Fe-r-oz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
""" | ||
mutable struct DirectReservation | ||
device_arn::String | ||
reservation_arn::String | ||
is_active::Bool | ||
end | ||
|
||
function DirectReservation(device_arn::String, reservation_arn::String) | ||
Fe-r-oz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return DirectReservation(device_arn, reservation_arn, false) | ||
end | ||
|
||
# Start reservation function | ||
function start_reservation!(state::DirectReservation) | ||
if state.is_active | ||
error("Another reservation is already active.") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why not include the |
||
end | ||
state.is_active = true | ||
ENV["AMZN_BRAKET_RESERVATION_DEVICE_ARN"] = state.device_arn | ||
ENV["AMZN_BRAKET_RESERVATION_TIME_WINDOW_ARN"] = state.reservation_arn | ||
end | ||
|
||
# Stop reservation function | ||
function stop_reservation!(state::DirectReservation) | ||
if !state.is_active | ||
@warn "Reservation is not active." | ||
end | ||
state.is_active = false | ||
delete!(ENV, "AMZN_BRAKET_RESERVATION_DEVICE_ARN") | ||
Fe-r-oz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
delete!(ENV, "AMZN_BRAKET_RESERVATION_TIME_WINDOW_ARN") | ||
end | ||
|
||
function direct_reservation(reservation::DirectReservation, func::Function) | ||
env_vars = Dict( | ||
"AMZN_BRAKET_RESERVATION_DEVICE_ARN" => reservation.device_arn, | ||
"AMZN_BRAKET_RESERVATION_TIME_WINDOW_ARN" => reservation.reservation_arn | ||
) | ||
withenv(pairs(env_vars)...) do | ||
start_reservation!(reservation) | ||
try | ||
func() | ||
Fe-r-oz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
finally | ||
stop_reservation!(reservation) | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why no doc link here for
AwsQuantumTask
?