Skip to content

Results are limited to Pulser v1.8.0

Product news
You are reading Pulser v1.8.0, an older version of this documentation. Go to the latest version (v1.10.0)

RemoteResults

class pulser.backend.RemoteResults(batch_id, connection, job_ids=None)

Bases: ResultsSequence

A collection of results obtained through a remote connection.

Parameters:
  • batch_id (str) – The ID that identifies the batch linked to the results.

  • connection (RemoteConnection) – The remote connection over which to get the batch’s status and fetch the results.

  • job_ids (list[str] | None, default: None) – If given, specifies which jobs within the batch should be included in the results and in what order. If left undefined, all jobs are included.

Attributes

batch_id

The ID of the batch containing these results.

job_ids

The IDs of the jobs within these results' batch.

results

The actual results, obtained after execution is done.

Methods

count

get_available_results

Returns the available results.

get_batch_status

Gets the status of the batch linked to these results.

index

Raises ValueError if the value is not present.

Signatures

count(value) → integer -- return number of occurrences of value
get_available_results()

Returns the available results.

Unlike the results property, this method does not raise an error if some of the jobs do not have results.

Returns:

A dictionary mapping the job ID to its results. Jobs with no result are omitted.

Return type:

dict[str, Results]

get_batch_status()

Gets the status of the batch linked to these results.

Return type:

BatchStatus

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

property batch_id: str

The ID of the batch containing these results.

property job_ids: list[str]

The IDs of the jobs within these results’ batch.

property results: tuple[Results, ...]

The actual results, obtained after execution is done.