RuntimeOptions
class RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)
Class for representing generic runtime execution options.
RuntimeOptions constructor.
Parameters
- backend (Optional[str | Backend]) – target backend to run on. This is required for
ibm_quantum
channel. - image (Optional[str]) – the runtime image used to execute the primitive, 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
, andCRITICAL
. The default level isWARNING
. - instance (Optional[str]) – The hub/group/project to use, in that format. This is only supported for
ibm_quantum
channel. IfNone
, 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
Type: str | Backend | None
Default value: None
image
Type: str | None
Default value: None
instance
Type: str | None
Default value: None
job_tags
Type: List[str] | None
Default value: None
log_level
Type: str | None
Default value: None
max_execution_time
Type: int | None
Default value: None
session_time
Type: int | None
Default value: None
Methods
get_backend_name
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?
Report a bug or request content on GitHub.