braket.tasks.annealing_quantum_task_result module

class braket.tasks.annealing_quantum_task_result.AnnealingQuantumTaskResult(record_array: numpy.recarray, variable_count: int, problem_type: str, task_metadata: Dict[str, Any], additional_metadata: Dict[str, Any])[source]

Bases: object

Result of an annealing problem quantum task execution. This class is intended to be initialized by a QuantumTask class.

Parameters
  • record_array (numpy.recarray) – numpy array with keys ‘solution’ (numpy.ndarray) where row is solution, column is value of the variable, ‘solution_count’ (numpy.ndarray) the number of times the solutions occurred, and ‘value’ (numpy.ndarray) the output or energy of the solutions.

  • variable_count (int) – the number of variables

  • problem_type (str) – the type of problem (‘ising’ or ‘qubo’)

  • task_metadata (Dict[str, Any]) – Dictionary of task metadata.

  • additional_metadata (Dict[str, Any]) – A dictionary of additional device-specific metadata

record_array: numpy.recarray = None
variable_count: int = None
problem_type: str = None
task_metadata: Dict[str, Any] = None
additional_metadata: Dict[str, Any] = None
data(selected_fields=None, sorted_by='value', reverse=False)[source]

Iterate over the data in record_array

Parameters
  • selected_fields (List[str], optional, default=None) – selected fields to return. Options are ‘solution’, ‘value’, and ‘solution_count’

  • sorted_by (str, optional, default='value') – Sorts the data by this field. Options are ‘solution’, ‘value’, and ‘solution_count’

  • reverse (bool, optional, default=False) – If True, returns the data in reverse order.

Yields

tuple – data in record_array

static from_dict(result: Dict[str, Any])[source]

Create AnnealingQuantumTaskResult from dict

Parameters

result (Dict[str, Any]) – Results dict with AnnealingQuantumTaskResult attributes as keys

Returns

AnnealingQuantumTaskResult – An AnnealingQuantumTaskResult based on the given dict

static from_string(result: str)braket.tasks.annealing_quantum_task_result.AnnealingQuantumTaskResult[source]

Create AnnealingQuantumTaskResult from string

Parameters

result (str) – JSON object string

Returns

AnnealingQuantumTaskResult – An AnnealingQuantumTaskResult based on the given string