English
Languages
English
Bengali
French
German
Japanese
Korean
Portuguese
Spanish
Tamil

AerJobSet

class AerJobSet(backend, job_id, fn, experiments, executor=None)[source]

Bases: qiskit.providers.job.JobV1

A set of AerJob classes for Qiskit Aer simulators.

An instance of this class is returned when you submit experiments with executor option. It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using result() and cancel all jobs using cancel().

AerJobSet constructor.

Parameters
  • backend (Aerbackend) – Aerbackend.

  • job_id (int) – Job Id.

  • fn (function) – a callable function to execute qobj on backend. This should usually be a bound AerBackend._run() method, with the signature (qobj: QasmQobj, job_id: str) -> Result.

  • experiments (List[QasmQobj]) – List[QasmQobjs] to execute.

  • executor (ThreadPoolExecutor or dask.distributed.client) – The executor to be used to submit the job.

Methods

backend

Return the backend where this job was executed.

cancel

Cancel all jobs in this job set.

cancelled

Return whether the job has been cancelled.

done

Return whether the job has successfully run.

executor

Return the executor for this job

in_final_state

Return whether the job is in a final job state such as DONE or ERROR.

job

Retrieve the job used to submit the specified experiment and its index.

job_id

Return a unique id identifying the job.

result

Return the results of the jobs as a single Result object.

running

Return whether the job is actively running.

status

Return the status of each job in this set.

submit

Execute this set of jobs on an executor.

wait_for_final_state

Poll the job status until it progresses to a final state such as DONE or ERROR.

worker

Retrieve the index of job.

worker_job

Retrieve the job specified with job's id

worker_results

Return the result of the jobs specified with worker_id.

Attributes

version = 1