316 lines
15 KiB
Plaintext
316 lines
15 KiB
Plaintext
---
|
||
title: BackendV2Converter (latest version)
|
||
description: API reference for qiskit.providers.BackendV2Converter in the latest version of qiskit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.BackendV2Converter
|
||
---
|
||
|
||
# BackendV2Converter
|
||
|
||
<Class id="qiskit.providers.BackendV2Converter" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L330-L452" signature="qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)" modifiers="class">
|
||
Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2")
|
||
|
||
A converter class that takes a [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") instance and wraps it in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface.
|
||
|
||
This class implements the [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface and is used to enable common access patterns between [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") and [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). This class should only be used if you need a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") and still need compatibility with [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1").
|
||
|
||
When using custom calibrations (or other custom workflows) it is **not** recommended to mutate the `BackendV1` object before applying this converter. For example, in order to convert a `BackendV1` object with a customized `defaults().instruction_schedule_map`, which has a custom calibration for an operation, the operation name must be in `configuration().basis_gates` and `name_mapping` must be supplied for the operation. Otherwise, the operation will be dropped in the resulting `BackendV2` object.
|
||
|
||
Instead it is typically better to add custom calibrations **after** applying this converter instead of updating `BackendV1.defaults()` in advance. For example:
|
||
|
||
```python
|
||
backend_v2 = BackendV2Converter(backend_v1)
|
||
backend_v2.target.add_instruction(
|
||
custom_gate, {(0, 1): InstructionProperties(calibration=custom_sched)}
|
||
)
|
||
```
|
||
|
||
Initialize a BackendV2 converter instance based on a BackendV1 instance.
|
||
|
||
**Parameters**
|
||
|
||
* **backend** ([*BackendV1*](qiskit.providers.BackendV1 "qiskit.providers.BackendV1")) – The input [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") based backend to wrap in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface
|
||
* **name\_mapping** (*Optional\[Dict\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any]]*) – An optional dictionary that maps custom gate/operation names in `backend` to an [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") object representing that gate/operation. By default most standard gates names are mapped to the standard gate object from [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") this only needs to be specified if the input `backend` defines gates in names outside that set.
|
||
* **add\_delay** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to true a [`Delay`](circuit#qiskit.circuit.Delay "qiskit.circuit.Delay") operation will be added to the target as a supported operation for all qubits
|
||
* **filter\_faulty** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If the [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object (if present) for `backend` has any qubits or gates flagged as non-operational filter those from the output target.
|
||
|
||
## Attributes
|
||
|
||
### coupling\_map
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.coupling_map">
|
||
Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object
|
||
</Attribute>
|
||
|
||
### dt
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.dt">
|
||
Return the system time resolution of input signals
|
||
|
||
This is required to be implemented if the backend supports Pulse scheduling.
|
||
|
||
**Returns**
|
||
|
||
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
|
||
</Attribute>
|
||
|
||
### dtm
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.dtm" />
|
||
|
||
### instruction\_durations
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.instruction_durations">
|
||
Return the [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object.
|
||
</Attribute>
|
||
|
||
### instruction\_schedule\_map
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.instruction_schedule_map">
|
||
Return the [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions defined in this backend’s target.
|
||
</Attribute>
|
||
|
||
### instructions
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.instructions">
|
||
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
|
||
</Attribute>
|
||
|
||
### max\_circuits
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.max_circuits" />
|
||
|
||
### meas\_map
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.meas_map" />
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.num_qubits">
|
||
Return the number of qubits the backend has.
|
||
</Attribute>
|
||
|
||
### operation\_names
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.operation_names">
|
||
A list of instruction names that the backend supports.
|
||
</Attribute>
|
||
|
||
### operations
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.operations">
|
||
A list of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instances that the backend supports.
|
||
</Attribute>
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.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.BackendV2Converter.run "qiskit.providers.BackendV2Converter.run") method.
|
||
</Attribute>
|
||
|
||
### provider
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.provider">
|
||
Return the backend Provider.
|
||
|
||
**Returns**
|
||
|
||
the Provider responsible for the backend.
|
||
|
||
**Return type**
|
||
|
||
[Provider](qiskit.providers.Provider "qiskit.providers.Provider")
|
||
</Attribute>
|
||
|
||
### target
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.target">
|
||
A [`qiskit.transpiler.Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object for the backend.
|
||
|
||
**Return type**
|
||
|
||
[Target](qiskit.transpiler.Target "qiskit.transpiler.Target")
|
||
</Attribute>
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.version" attributeValue="2" />
|
||
|
||
### name
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.name">
|
||
Name of the backend.
|
||
</Attribute>
|
||
|
||
### description
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.description">
|
||
Optional human-readable description.
|
||
</Attribute>
|
||
|
||
### online\_date
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.online_date">
|
||
Date that the backend came online.
|
||
</Attribute>
|
||
|
||
### backend\_version
|
||
|
||
<Attribute id="qiskit.providers.BackendV2Converter.backend_version">
|
||
Version of the backend being provided. This is not the same as [`BackendV2.version`](qiskit.providers.BackendV2#version "qiskit.providers.BackendV2.version"), which is the version of the [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") abstract interface.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### acquire\_channel
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.acquire_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L445-L446" signature="acquire_channel(qubit)">
|
||
Return the acquisition channel for the given qubit.
|
||
|
||
This is required to be implemented if the backend supports Pulse scheduling.
|
||
|
||
**Returns**
|
||
|
||
The Qubit measurement acquisition line.
|
||
|
||
**Return type**
|
||
|
||
[AcquireChannel](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")
|
||
|
||
**Raises**
|
||
|
||
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping
|
||
</Function>
|
||
|
||
### control\_channel
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.control_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L448-L449" signature="control_channel(qubits)">
|
||
Return the secondary drive channel for the given qubit
|
||
|
||
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
|
||
|
||
This is required to be implemented if the backend supports Pulse scheduling.
|
||
|
||
**Parameters**
|
||
|
||
**qubits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
|
||
|
||
**Returns**
|
||
|
||
The multi qubit control line.
|
||
|
||
**Return type**
|
||
|
||
List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")]
|
||
|
||
**Raises**
|
||
|
||
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping
|
||
</Function>
|
||
|
||
### drive\_channel
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.drive_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L439-L440" signature="drive_channel(qubit)">
|
||
Return the drive channel for the given qubit.
|
||
|
||
This is required to be implemented if the backend supports Pulse scheduling.
|
||
|
||
**Returns**
|
||
|
||
The Qubit drive channel
|
||
|
||
**Return type**
|
||
|
||
[DriveChannel](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel")
|
||
|
||
**Raises**
|
||
|
||
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping
|
||
</Function>
|
||
|
||
### measure\_channel
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.measure_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L442-L443" signature="measure_channel(qubit)">
|
||
Return the measure stimulus channel for the given qubit.
|
||
|
||
This is required to be implemented if the backend supports Pulse scheduling.
|
||
|
||
**Returns**
|
||
|
||
The Qubit measurement stimulus line
|
||
|
||
**Return type**
|
||
|
||
[MeasureChannel](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel")
|
||
|
||
**Raises**
|
||
|
||
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping
|
||
</Function>
|
||
|
||
### qubit\_properties
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.qubit_properties" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend.py#L493-L525" signature="qubit_properties(qubit)">
|
||
Return QubitProperties for a given qubit.
|
||
|
||
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order
|
||
|
||
**Returns**
|
||
|
||
The [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
|
||
|
||
**Raises**
|
||
|
||
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the qubit properties
|
||
|
||
**Return type**
|
||
|
||
[*QubitProperties*](qiskit.providers.QubitProperties "qiskit.providers.backend.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit.providers.backend.QubitProperties")]
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.run" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend_compat.py#L451-L452" signature="run(run_input, **options)">
|
||
Run on the backend.
|
||
|
||
This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation.
|
||
|
||
**Parameters**
|
||
|
||
* **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or*[*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – An individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock"), or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects to run on the backend.
|
||
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
|
||
|
||
**Returns**
|
||
|
||
The job object for the run
|
||
|
||
**Return type**
|
||
|
||
[Job](qiskit.providers.Job "qiskit.providers.Job")
|
||
</Function>
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit.providers.BackendV2Converter.set_options" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/providers/backend.py#L594-L611" signature="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**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the field passed in is not part of the options
|
||
</Function>
|
||
</Class>
|
||
|