152 lines
5.6 KiB
Plaintext
152 lines
5.6 KiB
Plaintext
---
|
||
title: ConvertISAToClifford (latest version)
|
||
description: API reference for qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford in the latest version of qiskit-ibm-runtime
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford
|
||
---
|
||
|
||
# ConvertISAToClifford
|
||
|
||
<Class id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.36/qiskit_ibm_runtime/transpiler/passes/cliffordization/convert_isa_to_clifford.py#L29-L81" signature="ConvertISAToClifford(*args, **kwargs)" modifiers="class">
|
||
Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.3)")
|
||
|
||
Convert the gates of an ISA circuit to Clifford gates.
|
||
|
||
ISA circuits only contain Clifford gates from a restricted set or [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.3)")s by arbitrary angles. To convert them to Clifford circuits, this pass rounds the angle of every [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.3)") to the closest multiple of pi/2 (or to a random multiple of pi/2 if the angle is unspecified), while it skips every Clifford gate, measurement, and barrier.
|
||
|
||
```python
|
||
import numpy as np
|
||
|
||
from qiskit.circuit import QuantumCircuit, Parameter
|
||
from qiskit.transpiler import PassManager
|
||
|
||
from qiskit_ibm_runtime.transpiler.passes import ConvertISAToClifford
|
||
|
||
# An ISA circuit ending with a Z rotation by pi/3
|
||
qc = QuantumCircuit(2, 2)
|
||
qc.sx(0)
|
||
qc.rz(np.pi/2, 0)
|
||
qc.sx(0)
|
||
qc.barrier()
|
||
qc.cx(0, 1)
|
||
qc.rz(np.pi/3, 0) # non-Clifford Z rotation
|
||
qc.rz(Parameter("th"), 0) # Z rotation with unspecified angle
|
||
|
||
# Turn into a Clifford circuit
|
||
pm = PassManager([ConvertISAToClifford()])
|
||
clifford_qc = pm.run(qc)
|
||
```
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – If the given circuit contains unsupported operations, such as non-ISA gates.
|
||
|
||
## Attributes
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.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_ibm_runtime.transpiler.passes.ConvertISAToClifford.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
|
||
|
||
### \_\_call\_\_
|
||
|
||
<Function id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.__call__" signature="__call__(circuit, property_set=None)">
|
||
Runs the pass on circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
|
||
* **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
|
||
|
||
**Returns**
|
||
|
||
If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
|
||
|
||
**Return type**
|
||
|
||
QuantumCircuit
|
||
</Function>
|
||
|
||
### execute
|
||
|
||
<Function id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.execute" signature="execute(passmanager_ir, state, callback=None)">
|
||
Execute optimization task for input Qiskit IR.
|
||
|
||
**Parameters**
|
||
|
||
* **passmanager\_ir** (*Any*) – Qiskit IR to optimize.
|
||
* **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – 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*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
|
||
</Function>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.name" signature="name()">
|
||
Name of the pass.
|
||
|
||
**Return type**
|
||
|
||
str
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.36/qiskit_ibm_runtime/transpiler/passes/cliffordization/convert_isa_to_clifford.py#L66-L81" signature="run(dag)">
|
||
Run a pass on the DAGCircuit. This is implemented by the pass developer.
|
||
|
||
**Parameters**
|
||
|
||
**dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run.
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – when this is left unimplemented for a pass.
|
||
|
||
**Return type**
|
||
|
||
[*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")
|
||
</Function>
|
||
|
||
### update\_status
|
||
|
||
<Function id="qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.update_status" signature="update_status(state, run_state)">
|
||
Update workflow status.
|
||
|
||
**Parameters**
|
||
|
||
* **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update.
|
||
* **run\_state** (*RunState*) – Completion status of current task.
|
||
|
||
**Returns**
|
||
|
||
Updated pass manager state.
|
||
|
||
**Return type**
|
||
|
||
[*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
|
||
</Function>
|
||
</Class>
|
||
|