RuntimeProgram¶
- class 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)[소스]¶
기반 클래스:
object
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().metadata}")
RuntimeProgram constructor.
- 매개변수
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
]) –True
if program is visible to all.False
if it’s only visible to you.data (
str
) – Program data.api_client (
Optional
[RuntimeClient
]) – Runtime api client.
Methods
Program parameter namespace.
Convert program metadata to dictionary format.
Attributes
- backend_requirements¶
Backend requirements.
- 반환 형식
Dict
- 반환
Backend requirements for this program.
- creation_date¶
Program creation date.
- 반환 형식
str
- 반환
Program creation date.
- data¶
Program data.
- 반환 형식
str
- 반환
Program data.
- 예외 발생
IBMQNotAuthorizedError – if user is not the program author.
- description¶
Program description.
- 반환 형식
str
- 반환
Program description.
- interim_results¶
Program interim result definitions.
- 반환 형식
Dict
- 반환
Interim result definitions for this program.
- is_public¶
Whether the program is visible to all.
- 반환 형식
bool
- 반환
Whether the program is public.
- max_execution_time¶
Maximum execution time in seconds.
A program execution exceeding this time will be forcibly terminated.
- 반환 형식
int
- 반환
Maximum execution time.
- name¶
Program name.
- 반환 형식
str
- 반환
Program name.
- program_id¶
Program ID.
- 반환 형식
str
- 반환
Program ID.
- return_values¶
Program return value definitions.
- 반환 형식
Dict
- 반환
Return value definitions for this program.
- update_date¶
Program last updated date.
- 반환 형식
str
- 반환
Program last updated date.