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


class HighLevelSynthesis(*args, **kwargs)

GitHub(opens in a new tab)

Bases: qiskit.transpiler.basepasses.TransformationPass

Synthesize higher-level objects by choosing the appropriate synthesis method based on the object’s name and the high-level-synthesis config of type HLSConfig (if provided).

As an example, let us assume that op_a and op_b are names of two higher-level objects, that op_a-objects have two synthesis methods default which does require any additional parameters and other with two optional integer parameters option_1 and option_2, that op_b-objects have a single synthesis method default, and qc is a quantum circuit containing op_a and op_b objects. The following code snippet:

hls_config = HLSConfig(op_b=[("other", {"option_1": 7, "option_2": 4})])
pm = PassManager([HighLevelSynthesis(hls_config=hls_config)])
transpiled_qc =

shows how to run the alternative synthesis method other for op_b-objects, while using the default methods for all other high-level objects, including op_a-objects.



Return the name of the pass.


Run the HighLevelSynthesis pass on dag. :type dag: DAGCircuit :param dag: input dag.

Return type



Output dag with certain Operations synthesized (as specified by the hls_config).


TranspilerError – when the specified synthesis method is not available.



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.


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).

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