Skip to main contentIBM Quantum Documentation

RuntimeOptions

RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)GitHub(opens in a new tab)

Class for representing generic runtime execution options.

RuntimeOptions constructor.

Parameters

  • backend (Optional[str]) – target backend to run on. This is required for ibm_quantum channel.
  • image (Optional[str]) – the runtime image used to execute the program, specified in the form of image_name:tag. Not all accounts are authorized to select a different image.
  • log_level (Optional[str]) – logging level to set in the execution environment. The valid log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL. The default level is WARNING.
  • instance (Optional[str]) – The hub/group/project to use, in that format. This is only supported for ibm_quantum channel. If None, a hub/group/project that provides access to the target backend is randomly selected.
  • job_tags (Optional[List[str]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the jobs() function call.
  • max_execution_time (Optional[int]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time.
  • session_time (Optional[int]) – Length of session in seconds.

Attributes

backend

str | None

= None

image

str | None

= None

instance

str | None

= None

job_tags

List[str] | None

= None

log_level

str | None

= None

max_execution_time

int | None

= None

session_time

int | None

= None


Methods

validate

validate(channel)

Validate options.

Parameters

channel (str) – channel type.

Raises

IBMInputValueError – If one or more option is invalid.

Return type

None

Was this page helpful?