RuntimeProgram
RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)
Class representing program metadata.
This class contains the metadata describing a program, such as its name, ID, description, etc.
You can use the QiskitRuntimeService to retrieve the metadata of a specific program or all programs. For example:
from qiskit_ibm_runtime import QiskitRuntimeService
service = QiskitRuntimeService()
# To retrieve metadata of all programs.
programs = service.programs()
# To retrieve metadata of a single program.
program = service.program(program_id='sampler')
print(f"Program {program.name} takes parameters {program.parameters().metadata}")RuntimeProgram constructor.
Parameters
- program_name (
str) – Program name. - program_id (
str) – Program ID. - description (
str) – Program description. - parameters (
Optional[Dict]) – Documentation on program parameters. - return_values (
Optional[Dict]) – Documentation on program return values. - interim_results (
Optional[Dict]) – Documentation on program interim results. - max_execution_time (
int) – Maximum execution time. - backend_requirements (
Optional[Dict]) – Backend requirements. - creation_date (
str) – Program creation date. - update_date (
str) – Program last updated date. - is_public (
Optional[bool]) –Trueif program is visible to all.Falseif it’s only visible to you. - data (
str) – Program data. - api_client (
Optional[RuntimeClient]) – Runtime api client.
Attributes
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.
data
Program data.
Return type
str
Returns
Program data.
Raises
IBMNotAuthorizedError – if user is not the program author.
description
Program description.
Return type
str
Returns
Program description.
interim_results
Program interim result definitions.
Return type
Dict
Returns
Interim result definitions for this program.
is_public
Whether the program is visible to all.
Return type
bool
Returns
Whether the program is public.
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.
program_id
Program ID.
Return type
str
Returns
Program ID.
return_values
Program return value definitions.
Return type
Dict
Returns
Return value definitions for this program.
update_date
Program last updated date.
Return type
str
Returns
Program last updated date.
Methods
parameters
parameters()
Program parameter namespace.
You can use the returned namespace to assign parameter values and pass the namespace to qiskit_ibm_runtime.QiskitRuntimeService.run(). The namespace allows you to use auto-completion to find program parameters.
Note that each call to this method returns a new namespace instance and does not include any modification to the previous instance.
Return type
Returns
Program parameter namespace.
to_dict
to_dict()
Convert program metadata to dictionary format.
Return type
Dict
Returns
Program metadata in dictionary format.