qiskit.providers.aer.AerJob

class AerJob(backend, job_id, fn, qobj, *args)

AerJob class.

_executor

executor to handle asynchronous jobs

Type

futures.Executor

Initializes the asynchronous job.

Parâmetros

• backend – the backend used to run the job.

• job_id – a unique id in the context of the backend used to run the job.

__init__(backend, job_id, fn, qobj, *args)

Initializes the asynchronous job.

Parâmetros

• backend – the backend used to run the job.

• job_id – a unique id in the context of the backend used to run the job.

Methods

__init__(backend, job_id, fn, qobj, *args)	Initializes the asynchronous job.
backend()	Return the instance of the backend used for this job.
cancel()	Attempt to cancel the job.
cancelled()	Return whether the job has been cancelled.
done()	Return whether the job has successfully run.
in_final_state()	Return whether the job is in a final job state.
job_id()	Return a unique id identifying the job.
qobj()	Return the Qobj submitted for this job.
result([timeout])	Get job result.
running()	Return whether the job is actively running.
status()	Gets the status of the job by querying the Python’s future
submit()	Submit the job to the backend for execution.
wait_for_final_state([timeout, wait, callback])	Poll the job status until it progresses to a final state such as DONE or ERROR.

backend()

Return the instance of the backend used for this job.

cancel()

Attempt to cancel the job.

cancelled()

Return whether the job has been cancelled.

Tipo de retorno

bool

done()

Return whether the job has successfully run.

Tipo de retorno

bool

in_final_state()

Return whether the job is in a final job state.

Tipo de retorno

bool

job_id()

Return a unique id identifying the job.

Tipo de retorno

str

qobj()

Return the Qobj submitted for this job.

Retorna

the Qobj submitted for this job.

Tipo de retorno

Qobj

result(timeout=None)

Get job result. The behavior is the same as the underlying concurrent Future objects,

https://docs.python.org/3/library/concurrent.futures.html#future-objects

Parâmetros

timeout (float) – number of seconds to wait for results.

Retorna

Result object

Tipo de retorno

qiskit.Result

Levanta

• concurrent.futures.TimeoutError – if timeout occurred.

• concurrent.futures.CancelledError – if job cancelled before completed.

running()

Return whether the job is actively running.

Tipo de retorno

bool

status()

Gets the status of the job by querying the Python’s future

Retorna

The current JobStatus

Tipo de retorno

JobStatus

Levanta

• JobError – If the future is in unexpected state

• concurrent.futures.TimeoutError – if timeout occurred.

submit()

Submit the job to the backend for execution.

Levanta

• QobjValidationError – if the JSON serialization of the Qobj passed

• during construction does not validate against the Qobj schema. –

• JobError – if trying to re-submit the job.

wait_for_final_state(timeout=None, wait=5, callback=None)

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

Parâmetros

• timeout (Optional[float]) – Seconds to wait for the job. If None, wait indefinitely.

• wait (float) – Seconds between queries.

• callback (Optional[Callable]) –

  Callback function invoked after each query. The following positional arguments are provided to the callback function:

  • job_id: Job ID

  • job_status: Status of the job from the last query

  • job: This BaseJob instance

  Note: different subclass might provide different arguments to the callback function.

Levanta

JobTimeoutError – If the job does not reach a final state before the specified timeout.

Tipo de retorno

None