Tamil
மொழிகள்
English
Bengali
French
German
Japanese
Korean
Portuguese
Spanish
Tamil

RuntimeJob

class RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=<class 'qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder'>, image='')[source]

Bases: object

Representation of a runtime program execution.

A new RuntimeJob instance is returned when you call IBMRuntimeService.run to execute a runtime program, or IBMRuntimeService.job to retrieve a previously executed job.

If the program execution is successful, you can inspect the job's status by calling status(). Job status can be one of the JobStatus members.

Some of the methods in this class are blocking, which means control may not be returned immediately. result() is an example of a blocking method:

job = provider.runtime.run(...)

try:
    job_result = job.result()  # It will block until the job finishes.
    print("The job finished with result {}".format(job_result))
except RuntimeJobFailureError as ex:
    print("Job failed!: {}".format(ex))

If the program has any interim results, you can use the callback parameter of the run() method to stream the interim results. Alternatively, you can use the stream_results() method to stream the results at a later time, but before the job finishes.

RuntimeJob constructor.

Parameters
  • backend (Backend) -- The backend instance used to run this job.

  • api_client (RuntimeClient) -- Object for connecting to the server.

  • credentials (Credentials) -- Account credentials.

  • job_id (str) -- Job ID.

  • program_id (str) -- ID of the program this job is for.

  • params (Optional[Dict]) -- Job parameters.

  • creation_date (Optional[str]) -- Job creation date, in UTC.

  • user_callback (Optional[Callable]) -- User callback function.

  • result_decoder (Type[ResultDecoder]) -- A ResultDecoder subclass used to decode job results.

  • image (Optional[str]) -- Runtime image used for this job: image_name:tag.

Methods

backend

Return the backend where this job was executed.

cancel

Cancel the job.

cancel_result_streaming

Cancel result streaming.

error_message

Returns the reason if the job failed.

job_id

Return a unique ID identifying the job.

logs

Return job logs.

result

Return the results of the job.

status

Return the status of the job.

stream_results

Start streaming job results.

wait_for_final_state

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

Attributes

creation_date

Job creation date in local time.

Return type

Optional[datetime]

Returns

The job creation date as a datetime object, in local time, or None if creation date is not available.

image

Return the runtime image used for the job.

Returns

image_name:tag or "" if the default image is used.

Return type

Runtime image

inputs

Job input parameters.

Return type

Dict

Returns

Input parameters used in this job.

program_id

Program ID.

Return type

str

Returns

ID of the program this job is for.