qiskit.providers.ibmq.runtime.RuntimeProgram
class RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')
Class representing program metadata.
This class contains the metadata describing a program, such as its name, ID, description, etc.
You can use the IBMRuntimeService to retrieve the metadata of a specific program or all programs. For example:
from qiskit import IBMQ
provider = IBMQ.load_account()
# To retrieve metadata of all programs.
programs = provider.runtime.programs()
# To retrieve metadata of a single program.
program = provider.runtime.program(program_id='circuit-runner')
print(f"Program {program.name} takes parameters {program.parameters}")RuntimeProgram constructor.
Parameters
- program_name (
str) – Program name. - program_id (
str) – Program ID. - description (
str) – Program description. - parameters (
Optional[List]) – Documentation on program parameters. - return_values (
Optional[List]) – Documentation on program return values. - interim_results (
Optional[List]) – Documentation on program interim results. - max_execution_time (
int) – Maximum execution time. - version (
str) – Program version. - backend_requirements (
Optional[Dict]) – Backend requirements. - creation_date (
str) – Program creation date.
__init__
__init__(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')
RuntimeProgram constructor.
Parameters
- program_name (
str) – Program name. - program_id (
str) – Program ID. - description (
str) – Program description. - parameters (
Optional[List]) – Documentation on program parameters. - return_values (
Optional[List]) – Documentation on program return values. - interim_results (
Optional[List]) – Documentation on program interim results. - max_execution_time (
int) – Maximum execution time. - version (
str) – Program version. - backend_requirements (
Optional[Dict]) – Backend requirements. - creation_date (
str) – Program creation date.
Methods
__init__(program_name, program_id, description) | RuntimeProgram constructor. |
to_dict() | Convert program metadata to dictionary format. |
Attributes
backend_requirements | Backend requirements. |
creation_date | Program creation date. |
description | Program description. |
interim_results | Program interim result definitions. |
max_execution_time | Maximum execution time in seconds. |
name | Program name. |
parameters | Program parameter definitions. |
program_id | Program ID. |
return_values | Program return value definitions. |
version | Program version. |
backend_requirements
Backend requirements.
Return type
Dict
Returns
Backend requirements for this program.
creation_date
Program creation date.
Return type
str
Returns
Program creation date.
description
Program description.
Return type
str
Returns
Program description.
interim_results
Program interim result definitions.
Return type
List[ProgramResult]
Returns
Interim result definitions for this program.
max_execution_time
Maximum execution time in seconds.
A program execution exceeding this time will be forcibly terminated.
Return type
int
Returns
Maximum execution time.
name
Program name.
Return type
str
Returns
Program name.
parameters
Program parameter definitions.
Return type
List[ProgramParameter]
Returns
Parameter definitions for this program.
program_id
Program ID.
Return type
str
Returns
Program ID.
return_values
Program return value definitions.
Return type
List[ProgramResult]
Returns
Return value definitions for this program.
to_dict
to_dict()
Convert program metadata to dictionary format.
Return type
Dict
Returns
Program metadata in dictionary format.
version
Program version.
Return type
str
Returns
Program version.