195 lines
7.0 KiB
Plaintext
195 lines
7.0 KiB
Plaintext
---
|
||
title: ProgramBackend (v0.31)
|
||
description: API reference for qiskit.providers.ibmq.runtime.ProgramBackend in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend
|
||
---
|
||
|
||
# ProgramBackend
|
||
|
||
<Class id="qiskit.providers.ibmq.runtime.ProgramBackend" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/program_backend.py" signature="ProgramBackend(configuration, provider=None, **fields)" modifiers="class">
|
||
Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC`
|
||
|
||
Base class for a program backend.
|
||
|
||
This is a [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits.
|
||
|
||
Initialize a backend class
|
||
|
||
**Parameters**
|
||
|
||
* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object.
|
||
* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from.
|
||
* **fields** – kwargs for the values to use to override the default options.
|
||
|
||
**Raises**
|
||
|
||
**AttributeError** – if input field not a valid options
|
||
|
||
In addition to the public abstract methods, subclasses should also implement the following private methods:
|
||
|
||
### \_default\_options
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend._default_options" signature="_default_options()" modifiers="abstract classmethod">
|
||
Return the default options
|
||
|
||
This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend.
|
||
|
||
**Returns**
|
||
|
||
**A options object with**
|
||
|
||
default values set
|
||
|
||
**Return type**
|
||
|
||
[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options")
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-configuration" />
|
||
|
||
### configuration
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.configuration" signature="ProgramBackend.configuration()">
|
||
Return the backend configuration.
|
||
|
||
**Returns**
|
||
|
||
the configuration for the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-name" />
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.name" signature="ProgramBackend.name()">
|
||
Return the backend name.
|
||
|
||
**Returns**
|
||
|
||
the name of the backend.
|
||
|
||
**Return type**
|
||
|
||
str
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-properties" />
|
||
|
||
### properties
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.properties" signature="ProgramBackend.properties()">
|
||
Return the backend properties.
|
||
|
||
**Returns**
|
||
|
||
the configuration for the backend. If the backend does not support properties, it returns `None`.
|
||
|
||
**Return type**
|
||
|
||
[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-provider" />
|
||
|
||
### provider
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.provider" signature="ProgramBackend.provider()">
|
||
Return the backend Provider.
|
||
|
||
**Returns**
|
||
|
||
the Provider responsible for the backend.
|
||
|
||
**Return type**
|
||
|
||
[Provider](qiskit.providers.Provider "qiskit.providers.Provider")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-run" />
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.run" signature="ProgramBackend.run(circuits, timeout=None, **run_config)" modifiers="abstract">
|
||
Run on the backend.
|
||
|
||
Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available.
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** (`Union`\[`QasmQobj`, `PulseQobj`, `QuantumCircuit`, `Schedule`, `List`\[`Union`\[`QuantumCircuit`, `Schedule`]]]) – An individual or a list of `QuantumCircuit` or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects to run on the backend. A [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") or a [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj") object is also supported but is deprecated.
|
||
* **timeout** (`Optional`\[`int`]) – Seconds to wait for circuit execution to finish.
|
||
* **\*\*run\_config** – Extra arguments used to configure the run.
|
||
|
||
**Return type**
|
||
|
||
`JobV1`
|
||
|
||
**Returns**
|
||
|
||
The job to be executed.
|
||
|
||
**Raises**
|
||
|
||
* [**IBMQBackendApiError**](qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError") – If an unexpected error occurred while submitting the job.
|
||
* [**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If an unexpected value received from the server.
|
||
* [**IBMQBackendValueError**](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError") – If an input parameter value is not valid.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-set-options" />
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.set_options" signature="ProgramBackend.set_options(**fields)">
|
||
Set the options fields for the backend
|
||
|
||
This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options.
|
||
|
||
**Parameters**
|
||
|
||
**fields** – The fields to update the options
|
||
|
||
**Raises**
|
||
|
||
**AttributeError** – If the field passed in is not part of the options
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-ibmq-runtime-programbackend-status" />
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ProgramBackend.status" signature="ProgramBackend.status()">
|
||
Return the backend status.
|
||
|
||
**Returns**
|
||
|
||
the status of the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit.providers.ibmq.runtime.ProgramBackend.options">
|
||
Return the options for the backend
|
||
|
||
The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.ibmq.runtime.ProgramBackend#run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method.
|
||
</Attribute>
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit.providers.ibmq.runtime.ProgramBackend.version" attributeValue="1" />
|
||
</Class>
|
||
|