AwsQuantumTask

class braket.aws.aws_quantum_task.AwsQuantumTask(arn, aws_session=None, poll_timeout_seconds=432000, poll_interval_seconds=1, logger=<Logger braket.aws.aws_quantum_task (WARNING)>, quiet=False, task_specification=None, **kwargs)[source]

Bases: QuantumTask

Amazon Braket implementation of a quantum task. A quantum task can be a circuit, an OpenQASM program or an AHS program.

Parameters:

arn (str)
aws_session (AwsSession | None)
poll_timeout_seconds (float)
poll_interval_seconds (float)
logger (Logger)
quiet (bool)
task_specification (Circuit | SerializableProgram | ProgramSet | Program | ProgramSet | AnalogHamiltonianSimulation | PulseSequence | None)

Initializes an AwsQuantumTask.

Parameters:

arn (str) – The ARN of the quantum task.
aws_session (AwsSession | None) – The AwsSession for connecting to AWS services. Default is None, in which case an AwsSession object will be created with the region of the quantum task.
poll_timeout_seconds (float) – The polling timeout for result(). Default: 5 days.
poll_interval_seconds (float) – The polling interval for result(). Default: 1 second.
logger (Logger) – Logger object with which to write logs, such as quantum task statuses while waiting for quantum task to be in a terminal state. Default is getLogger(__name__)
quiet (bool) – Sets the verbosity of the logger to low and does not report queue position. Default is False.
task_specification (TaskSpecification | None) – The specification the task was run with

Examples

>>> task = AwsQuantumTask(arn="task_arn")
>>> task.state()
'COMPLETED'
>>> result = task.result()
AnnealingQuantumTaskResult(...)

>>> task = AwsQuantumTask(arn="task_arn", poll_timeout_seconds=300)
>>> result = task.result()
GateModelQuantumTaskResult(...)

NO_RESULT_TERMINAL_STATES: ClassVar[set[str]] = {'CANCELLED', 'FAILED'}

RESULTS_READY_STATES: ClassVar[set[str]] = {'COMPLETED'}

TERMINAL_STATES: ClassVar[set[str]] = {'CANCELLED', 'COMPLETED', 'FAILED'}

DEFAULT_RESULTS_POLL_TIMEOUT = 432000

DEFAULT_RESULTS_POLL_INTERVAL = 1

RESULTS_FILENAME = 'results.json'

static create(aws_session, device_arn, task_specification, s3_destination_folder, shots, device_parameters=None, disable_qubit_rewiring=False, tags=None, inputs=None, gate_definitions=None, quiet=False, reservation_arn=None, experimental_capabilities=None, *args, **kwargs)[source]

AwsQuantumTask factory method that serializes a quantum task specification (either a quantum circuit or annealing problem), submits it to Amazon Braket, and returns back an AwsQuantumTask tracking the execution.

Parameters:

aws_session (AwsSession) – AwsSession to connect to AWS with.
device_arn (str) – The ARN of the quantum device.
task_specification (TaskSpecification) – Specification of the quantum task to run.
s3_destination_folder (AwsSession.S3DestinationFolder) – NamedTuple, with bucket for index 0 and key for index 1, that specifies the Amazon S3 bucket and folder to store quantum task results in.
shots (int) – The number of times to run the quantum task on the device. If the device is a simulator, this implies the state is sampled N times, where N = shots. shots=0 is only available on simulators and means that the simulator will compute the exact results based on the quantum task specification.
device_parameters (dict[str, Any] | None) – Additional parameters to send to the device.
disable_qubit_rewiring (bool) – Whether to run the circuit with the exact qubits chosen, without any rewiring downstream, if this is supported by the device. Only applies to digital, gate-based circuits (as opposed to annealing problems). If True, no qubit rewiring is allowed; if False, qubit rewiring is allowed. Default: False
tags (dict[str, str] | None) – Tags, which are Key-Value pairs to add to this quantum task. An example would be: {"state": "washington"}
inputs (dict[str, float] | None) – Inputs to be passed along with the IR. If the IR supports inputs, the inputs will be updated with this value. Default: {}.
gate_definitions (dict[tuple[Gate, QubitSet], PulseSequence] | None) – A dict of user defined gate calibrations. Each calibration is defined for a particular Gate on a particular QubitSet and is represented by a PulseSequence. Default: None.
quiet (bool) – Sets the verbosity of the logger to low and does not report queue position. Default is False.
reservation_arn (str | None) – The reservation ARN provided by Braket Direct to reserve exclusive usage for the device to run the quantum task on. Note: If you are creating tasks in a job that itself was created reservation ARN, those tasks do not need to be created with the reservation ARN. Default: None.
experimental_capabilities (str | None) – Experimental capabilities to enable for the quantum task. Supported values are “ALL” to enable all experimental capabilities. If None, the setting from the experimental capability context will be used if active. Default: None.

Return type:

AwsQuantumTask

Returns:

AwsQuantumTask – AwsQuantumTask tracking the quantum task execution on the device.

Note

The following arguments are typically defined via clients of Device.

task_specification
s3_destination_folder
shots