scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/0.26/qiskit.providers.models.Bac...

215 lines
11 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: BackendConfiguration (v0.26)
description: API reference for qiskit.providers.models.BackendConfiguration in qiskit v0.26
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.providers.models.BackendConfiguration
---
<span id="qiskit-providers-models-backendconfiguration" />
# qiskit.providers.models.BackendConfiguration
<Class id="qiskit.providers.models.BackendConfiguration" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py" signature="BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)" modifiers="class">
Backwards compat shim representing an abstract backend configuration.
Initialize a QasmBackendConfiguration Object
**Parameters**
* **backend\_name** (*str*) – The backend name
* **backend\_version** (*str*) – The backend version in the form X.Y.Z
* **n\_qubits** (*int*) – the number of qubits for the backend
* **basis\_gates** (*list*) – The list of strings for the basis gates of the backends
* **gates** (*list*) – The list of GateConfig objects for the basis gates of the backend
* **local** (*bool*) – True if the backend is local or False if remote
* **simulator** (*bool*) – True if the backend is a simulator
* **conditional** (*bool*) – True if the backend supports conditional operations
* **open\_pulse** (*bool*) – True if the backend supports OpenPulse
* **memory** (*bool*) – True if the backend supports memory
* **max\_shots** (*int*) – The maximum number of shots allowed on the backend
* **coupling\_map** (*list*) – The coupling map for the device
* **supported\_instructions** (*List\[str]*) – Instructions supported by the backend.
* **dynamic\_reprate\_enabled** (*bool*) – whether delay between programs can be set dynamically (ie via `rep_delay`). Defaults to False.
* **rep\_delay\_range** (*List\[float]*) – 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`.
* **default\_rep\_delay** (*float*) – Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`.
* **max\_experiments** (*int*) – The maximum number of experiments per job
* **sample\_name** (*str*) – Sample name for the backend
* **n\_registers** (*int*) – Number of register slots available for feedback (if conditional is True)
* **register\_map** (*list*) – An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot.
* **configurable** (*bool*) – True if the backend is configurable, if the backend is a simulator
* **credits\_required** (*bool*) – True if backend requires credits to run a job.
* **online\_date** (*datetime*) – The date that the device went online
* **display\_name** (*str*) – Alternate name field for the backend
* **description** (*str*) – A description for the backend
* **tags** (*list*) – A list of string tags to describe the backend
* **dt** (*float*) – Qubit drive channel timestep in nanoseconds.
* **dtm** (*float*) – Measurement drive channel timestep in nanoseconds.
* **processor\_type** (*dict*) –
Processor type for this backend. A dictionary of the form `{"family": <str>, "revision": <str>, segment: <str>}` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`.
* family: Processor family of this backend.
* revision: Revision version of this processor.
* segment: Segment this processor belongs to within a larger chip.
* **\*\*kwargs** – optional fields
### \_\_init\_\_
<Function id="qiskit.providers.models.BackendConfiguration.__init__" signature="__init__(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)">
Initialize a QasmBackendConfiguration Object
**Parameters**
* **backend\_name** (*str*) – The backend name
* **backend\_version** (*str*) – The backend version in the form X.Y.Z
* **n\_qubits** (*int*) – the number of qubits for the backend
* **basis\_gates** (*list*) – The list of strings for the basis gates of the backends
* **gates** (*list*) – The list of GateConfig objects for the basis gates of the backend
* **local** (*bool*) – True if the backend is local or False if remote
* **simulator** (*bool*) – True if the backend is a simulator
* **conditional** (*bool*) – True if the backend supports conditional operations
* **open\_pulse** (*bool*) – True if the backend supports OpenPulse
* **memory** (*bool*) – True if the backend supports memory
* **max\_shots** (*int*) – The maximum number of shots allowed on the backend
* **coupling\_map** (*list*) – The coupling map for the device
* **supported\_instructions** (*List\[str]*) – Instructions supported by the backend.
* **dynamic\_reprate\_enabled** (*bool*) – whether delay between programs can be set dynamically (ie via `rep_delay`). Defaults to False.
* **rep\_delay\_range** (*List\[float]*) – 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`.
* **default\_rep\_delay** (*float*) – Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`.
* **max\_experiments** (*int*) – The maximum number of experiments per job
* **sample\_name** (*str*) – Sample name for the backend
* **n\_registers** (*int*) – Number of register slots available for feedback (if conditional is True)
* **register\_map** (*list*) – An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot.
* **configurable** (*bool*) – True if the backend is configurable, if the backend is a simulator
* **credits\_required** (*bool*) – True if backend requires credits to run a job.
* **online\_date** (*datetime*) – The date that the device went online
* **display\_name** (*str*) – Alternate name field for the backend
* **description** (*str*) – A description for the backend
* **tags** (*list*) – A list of string tags to describe the backend
* **dt** (*float*) – Qubit drive channel timestep in nanoseconds.
* **dtm** (*float*) – Measurement drive channel timestep in nanoseconds.
* **processor\_type** (*dict*) –
Processor type for this backend. A dictionary of the form `{"family": <str>, "revision": <str>, segment: <str>}` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`.
* family: Processor family of this backend.
* revision: Revision version of this processor.
* segment: Segment this processor belongs to within a larger chip.
* **\*\*kwargs** – optional fields
</Function>
## Methods
| | |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`__init__`](#qiskit.providers.models.BackendConfiguration.__init__ "qiskit.providers.models.BackendConfiguration.__init__")(backend\_name, backend\_version, …) | Initialize a QasmBackendConfiguration Object |
| [`from_dict`](#qiskit.providers.models.BackendConfiguration.from_dict "qiskit.providers.models.BackendConfiguration.from_dict")(data) | Create a new GateConfig object from a dictionary. |
| [`to_dict`](#qiskit.providers.models.BackendConfiguration.to_dict "qiskit.providers.models.BackendConfiguration.to_dict")() | Return a dictionary format representation of the GateConfig. |
## Attributes
| | |
| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`num_qubits`](#qiskit.providers.models.BackendConfiguration.num_qubits "qiskit.providers.models.BackendConfiguration.num_qubits") | Returns the number of qubits. |
### from\_dict
<Function id="qiskit.providers.models.BackendConfiguration.from_dict" signature="from_dict(data)" modifiers="classmethod">
Create a new GateConfig object from a dictionary.
**Parameters**
**data** (*dict*) – A dictionary representing the GateConfig to create. It will be in the same format as output by [`to_dict()`](#qiskit.providers.models.BackendConfiguration.to_dict "qiskit.providers.models.BackendConfiguration.to_dict").
**Returns**
The GateConfig from the input dictionary.
**Return type**
[GateConfig](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig")
</Function>
### num\_qubits
<Attribute id="qiskit.providers.models.BackendConfiguration.num_qubits">
Returns the number of qubits.
In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution.
</Attribute>
### to\_dict
<Function id="qiskit.providers.models.BackendConfiguration.to_dict" signature="to_dict()">
Return a dictionary format representation of the GateConfig.
**Returns**
The dictionary form of the GateConfig.
**Return type**
dict
</Function>
</Class>
Reference in New Issue View Git Blame Copy Permalink