Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

TimeUnitConversion

class qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)

GitHub(opens in a new tab)

Bases: TransformationPass

Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that.

This pass will add a Instruction.duration metadata to each op whose duration is known which will be used by subsequent scheduling passes for scheduling.

If dt (in seconds) is known to transpiler, the unit 'dt' is chosen. Otherwise, the unit to be selected depends on what units are used in delays and instruction durations:

  • 's': if they are all in SI units.
  • 'dt': if they are all in the unit 'dt'.
  • raise error: if they are a mix of SI units and 'dt'.

TimeUnitAnalysis initializer.

Parameters

  • inst_durations (InstructionDurations) – A dictionary of durations of instructions.
  • target – The Target representing the target backend, if both inst_durations and target are specified then this argument will take precedence and inst_durations will be ignored.

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

Returns

Optimized Qiskit IR and state of the workflow.

Return type

tuple(opens in a new tab)[Any(opens in a new tab), qiskit.passmanager.compilation_status.PassManagerState]

name

name()

Name of the pass.

Return type

str(opens in a new tab)

run

run(dag)

Run the TimeUnitAnalysis pass on dag.

Parameters

dag (DAGCircuit) – DAG to be checked.

Returns

DAG with consistent timing and op nodes annotated with duration.

Return type

DAGCircuit

Raises

TranspilerError – if the units are not unifiable

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

PassManagerState

Was this page helpful?
Report a bug or request content on GitHub.