BackendV2Converter
class qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)
Bases: BackendV2
A converter class that takes a BackendV1 instance and wraps it in a BackendV2 interface.
This class implements the BackendV2 interface and is used to enable common access patterns between BackendV1 and BackendV2. This class should only be used if you need a BackendV2 and still need compatibility with 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:
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) – The input
BackendV1based backend to wrap in aBackendV2interface - name_mapping (Optional[Dict[str, Any]]) – An optional dictionary that maps custom gate/operation names in
backendto anOperationobject representing that gate/operation. By default most standard gates names are mapped to the standard gate object fromqiskit.circuit.librarythis only needs to be specified if the inputbackenddefines gates in names outside that set. - add_delay (bool) – If set to true a
Delayoperation will be added to the target as a supported operation for all qubits - filter_faulty (bool) – If the
BackendPropertiesobject (if present) forbackendhas any qubits or gates flagged as non-operational filter those from the output target.
Attributes
coupling_map
Return the CouplingMap object
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.
dtm
instruction_durations
Return the InstructionDurations object.
instruction_schedule_map
Return the InstructionScheduleMap for the instructions defined in this backend’s target.
The property qiskit.providers.backend.BackendV2.instruction_schedule_map is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.instruction_schedule_map will have no alternative in Qiskit.
instructions
A list of Instruction tuples on the backend of the form (instruction, (qubits)
max_circuits
meas_map
num_qubits
Return the number of qubits the backend has.
operation_names
A list of instruction names that the backend supports.
operations
A list of Instruction instances that the backend supports.
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() method.
provider
target
version
Default value: 2
name
Name of the backend.
description
Optional human-readable description.
online_date
Date that the backend came online.
backend_version
Version of the backend being provided. This is not the same as BackendV2.version, which is the version of the Backend abstract interface.
Methods
acquire_channel
acquire_channel(qubit)
The method qiskit.providers.backend_compat.BackendV2Converter.acquire_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend_compat.BackendV2Converter.acquire_channel() will have no alternative in Qiskit.
Parameters
qubit (int) –
control_channel
control_channel(qubits)
The method qiskit.providers.backend_compat.BackendV2Converter.control_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend_compat.BackendV2Converter.control_channel() will have no alternative in Qiskit.
Parameters
drive_channel
drive_channel(qubit)
The method qiskit.providers.backend_compat.BackendV2Converter.drive_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend_compat.BackendV2Converter.drive_channel() will have no alternative in Qiskit.
Parameters
qubit (int) –
measure_channel
measure_channel(qubit)
The method qiskit.providers.backend_compat.BackendV2Converter.measure_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend_compat.BackendV2Converter.measure_channel() will have no alternative in Qiskit.
Parameters
qubit (int) –
qubit_properties
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 |List[int]) – The qubit to get the QubitProperties object for. This can be a single integer for 1 qubit or a list of qubits and a list of QubitProperties objects will be returned in the same order
Returns
The 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 – if the backend doesn’t support querying the qubit properties
Return type
run
run(run_input, **options)
Run on the backend.
This method returns a 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 orSchedule orScheduleBlock orlist) – An individual or a list of
QuantumCircuit,ScheduleBlock, orScheduleobjects 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
set_options
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