PulseGates
class qiskit.transpiler.passes.PulseGates(*args, **kwargs)
Bases: CalibrationBuilder
Pulse gate adding pass.
This pass adds gate calibrations from the supplied InstructionScheduleMap to a quantum circuit.
This pass checks each DAG circuit node and acquires a corresponding schedule from the instruction schedule map object that may be provided by the target backend. Because this map is a mutable object, the end-user can provide a configured backend to execute the circuit with customized gate implementations.
This mapping object returns a schedule with “publisher” metadata which is an integer Enum value representing who created the gate schedule. If the gate schedule is provided by end-users, this pass attaches the schedule to the DAG circuit as a calibration.
This pass allows users to easily override quantum circuit with custom gate definitions without directly dealing with those schedules.
References
- [1] OpenQASM 3: A broader and deeper quantum assembly language https://arxiv.org/abs/2104.14722
Create new pass.
The class qiskit.transpiler.passes.calibration.pulse_gate.PulseGates 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.transpiler.passes.calibration.pulse_gate.PulseGates will have no alternative in Qiskit.
Parameters
- inst_map – Instruction schedule map that user may override.
- target – The
Targetrepresenting the target backend, if bothinst_mapandtargetare specified then it updates instructions in thetargetwithinst_map.
Attributes
is_analysis_pass
Check if the pass is an analysis pass.
If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
is_transformation_pass
Check if the pass is a transformation pass.
If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
Methods
execute
execute(passmanager_ir, state, callback=None)
Execute optimization task for input Qiskit IR.
Parameters
- passmanager_ir (Any) – Qiskit IR to optimize.
- state (PassManagerState) – State associated with workflow execution by the pass manager itself.
- callback (Callable | None) – A callback function which is caller per execution of optimization task.
Returns
Optimized Qiskit IR and state of the workflow.
Return type
tuple[Any, qiskit.passmanager.compilation_status.PassManagerState]
get_calibration
get_calibration(node_op, qubits)
Gets the calibrated schedule for the given instruction and qubits.
Parameters
- node_op (Instruction) – Target instruction object.
- qubits (List) – Integer qubit indices to check.
Returns
Return Schedule of target gate instruction.
Raises
TranspilerError – When node is parameterized and calibration is raw schedule object.
Return type
name
run
run(dag)
Run the calibration adder pass on dag.
Parameters
dag (DAGCircuit) – DAG to schedule.
Returns
A DAG with calibrations added to it.
Return type
supported
supported(node_op, qubits)
Determine if a given node supports the calibration.
Parameters
- node_op (Instruction) – Target instruction object.
- qubits (List) – Integer qubit indices to check.
Returns
Return True is calibration can be provided.
Return type
update_status
update_status(state, run_state)
Update workflow status.
Parameters
- state (PassManagerState) – Pass manager state to update.
- run_state (RunState) – Completion status of current task.
Returns
Updated pass manager state.
Return type