Skip to content

Commit 442021b

Browse files
Eric-ArellanoEric-Arellano
authored
Generate Transpiler 0.14.0 (#3790)
1 parent 632ec3e commit 442021b

29 files changed

+1159
-136
lines changed

‎docs/api/qiskit-ibm-transpiler/0.13/_package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "qiskit-ibm-transpiler",
3+
"version": "0.13.1"
4+
}

‎docs/api/qiskit-ibm-transpiler/0.13/_toc.json

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"title": "Qiskit Transpiler Service client",
3+
"children": [
4+
{
5+
"title": "API index",
6+
"url": "/docs/api/qiskit-ibm-transpiler/0.13"
7+
},
8+
{
9+
"title": "qiskit_ibm_transpiler.ai",
10+
"children": [
11+
{
12+
"title": "Module overview",
13+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai"
14+
},
15+
{
16+
"title": "AICliffordSynthesis",
17+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-ai-clifford-synthesis"
18+
},
19+
{
20+
"title": "AILinearFunctionSynthesis",
21+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-ai-linear-function-synthesis"
22+
},
23+
{
24+
"title": "AIPermutationSynthesis",
25+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-ai-permutation-synthesis"
26+
},
27+
{
28+
"title": "AIRouting",
29+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-ai-routing"
30+
},
31+
{
32+
"title": "CollectCliffords",
33+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-collect-cliffords"
34+
},
35+
{
36+
"title": "CollectLinearFunctions",
37+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-collect-linear-functions"
38+
},
39+
{
40+
"title": "CollectPermutations",
41+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/ai-collect-permutations"
42+
}
43+
]
44+
},
45+
{
46+
"title": "qiskit_ibm_transpiler.transpiler_service",
47+
"children": [
48+
{
49+
"title": "Module overview",
50+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/transpiler-service"
51+
},
52+
{
53+
"title": "TranspilerService",
54+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/transpiler-service-transpiler-service"
55+
}
56+
]
57+
},
58+
{
59+
"title": "qiskit_ibm_transpiler.utils",
60+
"url": "/docs/api/qiskit-ibm-transpiler/0.13/utils"
61+
},
62+
{
63+
"title": "Release notes",
64+
"url": "/docs/api/qiskit-ibm-transpiler/release-notes"
65+
}
66+
],
67+
"collapsed": true
68+
}

‎docs/api/qiskit-ibm-transpiler/0.13/ai-ai-clifford-synthesis.mdx

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: AICliffordSynthesis (v0.13)
3+
description: API reference for qiskit_ibm_transpiler.ai.AICliffordSynthesis in qiskit-ibm-transpiler v0.13
4+
in_page_toc_min_heading_level: 1
5+
python_api_type: class
6+
python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
7+
---
8+
9+
# AICliffordSynthesis
10+
11+
<Class id="qiskit_ibm_transpiler.ai.AICliffordSynthesis" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L181-L232" signature="qiskit_ibm_transpiler.ai.AICliffordSynthesis(coupling_map: list[list[int]] | None = None, backend: Backend | None = None, replace_only_if_better: bool = True, max_threads: int | None = None)" modifiers="class">
12+
Bases: `AISynthesis`
13+
14+
Synthesis for Clifford circuits (blocks of H, S and CX gates). Currently up to 9 qubit blocks.
15+
16+
**Parameters**
17+
18+
* **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits.
19+
* **backend** (*Backend, optional*) – Backend used for doing the AI Clifford synthesis.
20+
* **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True.
21+
* **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel.
22+
23+
## Attributes
24+
25+
### is\_analysis\_pass
26+
27+
<Attribute id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.is_analysis_pass">
28+
Check if the pass is an analysis pass.
29+
30+
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.
31+
</Attribute>
32+
33+
### is\_transformation\_pass
34+
35+
<Attribute id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.is_transformation_pass">
36+
Check if the pass is a transformation pass.
37+
38+
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).
39+
</Attribute>
40+
41+
## Methods
42+
43+
### execute
44+
45+
<Function id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.execute" signature="execute(passmanager_ir, state, callback=None)">
46+
Execute optimization task for input Qiskit IR.
47+
48+
**Parameters**
49+
50+
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")) – State associated with workflow execution by the pass manager itself.
52+
* **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task.
53+
54+
**Returns**
55+
56+
Optimized Qiskit IR and state of the workflow.
57+
58+
**Return type**
59+
60+
[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")]
61+
</Function>
62+
63+
### name
64+
65+
<Function id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.name" signature="name()">
66+
Name of the pass.
67+
68+
**Return type**
69+
70+
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")
71+
</Function>
72+
73+
### run
74+
75+
<Function id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.run" github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L161-L178" signature="run(dag)">
76+
Run a pass on the DAGCircuit. This is implemented by the pass developer.
77+
78+
**Parameters**
79+
80+
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v2.1)")) – the dag on which the pass is run.
81+
82+
**Raises**
83+
84+
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass.
85+
</Function>
86+
87+
### synth\_nodes
88+
89+
<Function id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.synth_nodes" github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L114-L159" signature="synth_nodes(nodes)" />
90+
91+
### update\_status
92+
93+
<Function id="qiskit_ibm_transpiler.ai.AICliffordSynthesis.update_status" signature="update_status(state, run_state)">
94+
Update workflow status.
95+
96+
**Parameters**
97+
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")) – Pass manager state to update.
99+
* **run\_state** (*RunState*) – Completion status of current task.
100+
101+
**Returns**
102+
103+
Updated pass manager state.
104+
105+
**Return type**
106+
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")
108+
</Function>
109+
</Class>
110+

‎docs/api/qiskit-ibm-transpiler/0.13/ai-ai-linear-function-synthesis.mdx

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: AILinearFunctionSynthesis (v0.13)
3+
description: API reference for qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis in qiskit-ibm-transpiler v0.13
4+
in_page_toc_min_heading_level: 1
5+
python_api_type: class
6+
python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
7+
---
8+
9+
# AILinearFunctionSynthesis
10+
11+
<Class id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L235-L285" signature="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis(coupling_map: list[list[int]] | None = None, backend: Backend | None = None, replace_only_if_better: bool = True, max_threads: int | None = None)" modifiers="class">
12+
Bases: `AISynthesis`
13+
14+
Synthesis for Linear Function circuits (blocks of CX and SWAP gates). Currently up to 9 qubit blocks.
15+
16+
**Parameters**
17+
18+
* **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits.
19+
* **backend** (*Backend, optional*) – Backend used for doing the AI Linear Function synthesis
20+
* **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True.
21+
* **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel.
22+
23+
## Attributes
24+
25+
### is\_analysis\_pass
26+
27+
<Attribute id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.is_analysis_pass">
28+
Check if the pass is an analysis pass.
29+
30+
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.
31+
</Attribute>
32+
33+
### is\_transformation\_pass
34+
35+
<Attribute id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.is_transformation_pass">
36+
Check if the pass is a transformation pass.
37+
38+
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).
39+
</Attribute>
40+
41+
## Methods
42+
43+
### execute
44+
45+
<Function id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.execute" signature="execute(passmanager_ir, state, callback=None)">
46+
Execute optimization task for input Qiskit IR.
47+
48+
**Parameters**
49+
50+
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")) – State associated with workflow execution by the pass manager itself.
52+
* **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task.
53+
54+
**Returns**
55+
56+
Optimized Qiskit IR and state of the workflow.
57+
58+
**Return type**
59+
60+
[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")]
61+
</Function>
62+
63+
### name
64+
65+
<Function id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.name" signature="name()">
66+
Name of the pass.
67+
68+
**Return type**
69+
70+
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")
71+
</Function>
72+
73+
### run
74+
75+
<Function id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.run" github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L161-L178" signature="run(dag)">
76+
Run a pass on the DAGCircuit. This is implemented by the pass developer.
77+
78+
**Parameters**
79+
80+
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v2.1)")) – the dag on which the pass is run.
81+
82+
**Raises**
83+
84+
[**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass.
85+
</Function>
86+
87+
### synth\_nodes
88+
89+
<Function id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.synth_nodes" github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.13/qiskit_ibm_transpiler/ai/synthesis.py#L114-L159" signature="synth_nodes(nodes)" />
90+
91+
### update\_status
92+
93+
<Function id="qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.update_status" signature="update_status(state, run_state)">
94+
Update workflow status.
95+
96+
**Parameters**
97+
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")) – Pass manager state to update.
99+
* **run\_state** (*RunState*) – Completion status of current task.
100+
101+
**Returns**
102+
103+
Updated pass manager state.
104+
105+
**Return type**
106+
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.1)")
108+
</Function>
109+
</Class>
110+

0 commit comments

Comments
 (0)