73 lines
3.0 KiB
Plaintext
73 lines
3.0 KiB
Plaintext
---
|
||
title: HighLevelSynthesis
|
||
description: API reference for qiskit.transpiler.passes.HighLevelSynthesis
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.passes.HighLevelSynthesis
|
||
---
|
||
|
||
# HighLevelSynthesis
|
||
|
||
<Class id="qiskit.transpiler.passes.HighLevelSynthesis" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/high_level_synthesis.py" signature="qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)" modifiers="class">
|
||
Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass")
|
||
|
||
Synthesize higher-level objects using synthesis plugins.
|
||
|
||
Synthesis plugins apply synthesis methods specified in the high-level-synthesis config (refer to the documentation for `HLSConfig`).
|
||
|
||
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:
|
||
|
||
```python
|
||
hls_config = HLSConfig(op_b=[("other", {"option_1": 7, "option_2": 4})])
|
||
pm = PassManager([HighLevelSynthesis(hls_config=hls_config)])
|
||
transpiled_qc = pm.run(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.
|
||
|
||
## Attributes
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.HighLevelSynthesis.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.
|
||
</Attribute>
|
||
|
||
### is\_transformation\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.HighLevelSynthesis.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).
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.transpiler.passes.HighLevelSynthesis.name" signature="name()">
|
||
Return the name of the pass.
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.transpiler.passes.HighLevelSynthesis.run" signature="run(dag)">
|
||
Run the HighLevelSynthesis pass on dag. :param dag: input dag.
|
||
|
||
**Returns**
|
||
|
||
Output dag with certain Operations synthesized (as specified by the hls\_config).
|
||
|
||
**Raises**
|
||
|
||
[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – when the specified synthesis method is not available.
|
||
|
||
**Return type**
|
||
|
||
[*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit")
|
||
</Function>
|
||
</Class>
|
||
|