Skip to content

Commit 45af29b

Browse files
authored
Generate qiskit-ibm-transpiler 0.11.1 (#3126)
This PR generates the docs for qiskit-ibm-transpiler 0.11.1 ``` npm run gen-api -- -p qiskit-ibm-transpiler --v 0.11.1 ```
1 parent 9f02f0f commit 45af29b

12 files changed

+152
-142
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"name": "qiskit-ibm-transpiler",
3-
"version": "0.11.0"
3+
"version": "0.11.1"
44
}

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
4848
**Parameters**
4949

5050
* **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 v1.4)")) – State associated with workflow execution by the pass manager itself.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5252
* **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.
5353

5454
**Returns**
@@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
5757

5858
**Return type**
5959

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 v1.4)")]
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.0)")]
6161
</Function>
6262

6363
### name
@@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
7777

7878
**Parameters**
7979

80-
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.4)")) – the dag on which the pass is run.
80+
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v2.0)")) – the dag on which the pass is run.
8181

8282
**Raises**
8383

@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
4848
**Parameters**
4949

5050
* **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 v1.4)")) – State associated with workflow execution by the pass manager itself.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5252
* **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.
5353

5454
**Returns**
@@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
5757

5858
**Return type**
5959

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 v1.4)")]
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.0)")]
6161
</Function>
6262

6363
### name
@@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
7777

7878
**Parameters**
7979

80-
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.4)")) – the dag on which the pass is run.
80+
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v2.0)")) – the dag on which the pass is run.
8181

8282
**Raises**
8383

@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

docs/api/qiskit-ibm-transpiler/ai-ai-permutation-synthesis.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
4848
**Parameters**
4949

5050
* **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 v1.4)")) – State associated with workflow execution by the pass manager itself.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5252
* **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.
5353

5454
**Returns**
@@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
5757

5858
**Return type**
5959

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 v1.4)")]
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.0)")]
6161
</Function>
6262

6363
### name
@@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
7777

7878
**Parameters**
7979

80-
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.4)")) – the dag on which the pass is run.
80+
**dag** ([*DAGCircuit*](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v2.0)")) – the dag on which the pass is run.
8181

8282
**Raises**
8383

@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

docs/api/qiskit-ibm-transpiler/ai-ai-routing.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
99
# AIRouting
1010

1111
<Class id="qiskit_ibm_transpiler.ai.AIRouting" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.11/qiskit_ibm_transpiler/ai/routing.py#L98-L274" signature="qiskit_ibm_transpiler.ai.AIRouting(coupling_map: list[list[int]] | None = None, backend: Backend | None = None, optimization_level: int = 2, layout_mode: str = 'OPTIMIZE')" modifiers="class">
12-
Bases: [`TransformationPass`](/docs/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.4)")
12+
Bases: [`TransformationPass`](/docs/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v2.0)")
1313

1414
The AIRouting pass acts both as a layout stage and a routing stage.
1515

@@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
4848
**Parameters**
4949

5050
* **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 v1.4)")) – State associated with workflow execution by the pass manager itself.
51+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5252
* **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.
5353

5454
**Returns**
@@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
5757

5858
**Return type**
5959

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 v1.4)")]
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.0)")]
6161
</Function>
6262

6363
### name
@@ -100,7 +100,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
100100

101101
**Parameters**
102102

103-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
103+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
104104
* **run\_state** (*RunState*) – Completion status of current task.
105105

106106
**Returns**
@@ -109,7 +109,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
109109

110110
**Return type**
111111

112-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
112+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
113113
</Function>
114114
</Class>
115115

docs/api/qiskit-ibm-transpiler/ai-collect-cliffords.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
5252
**Parameters**
5353

5454
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
55-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – State associated with workflow execution by the pass manager itself.
55+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5656
* **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.
5757

5858
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
6161

6262
**Return type**
6363

64-
[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 v1.4)")]
64+
[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.0)")]
6565
</Function>
6666

6767
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

docs/api/qiskit-ibm-transpiler/ai-collect-linear-functions.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
5252
**Parameters**
5353

5454
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
55-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – State associated with workflow execution by the pass manager itself.
55+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5656
* **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.
5757

5858
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
6161

6262
**Return type**
6363

64-
[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 v1.4)")]
64+
[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.0)")]
6565
</Function>
6666

6767
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

docs/api/qiskit-ibm-transpiler/ai-collect-permutations.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
5252
**Parameters**
5353

5454
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
55-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – State associated with workflow execution by the pass manager itself.
55+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – State associated with workflow execution by the pass manager itself.
5656
* **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.
5757

5858
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
6161

6262
**Return type**
6363

64-
[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 v1.4)")]
64+
[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.0)")]
6565
</Function>
6666

6767
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
9595

9696
**Parameters**
9797

98-
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")) – Pass manager state to update.
98+
* **state** ([*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")) – Pass manager state to update.
9999
* **run\_state** (*RunState*) – Completion status of current task.
100100

101101
**Returns**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
104104

105105
**Return type**
106106

107-
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.4)")
107+
[*PassManagerState*](/docs/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v2.0)")
108108
</Function>
109109
</Class>
110110

0 commit comments

Comments
 (0)