From 05b9223a5b0316df3955239922914e5e9982433b Mon Sep 17 00:00:00 2001
From: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Date: Thu, 12 Dec 2024 18:22:11 +0100
Subject: [PATCH] Generate qiskit-ibm-transpiler 0.9.2 API docs (#2467)
This PR generates the docs for qiskit-ibm-transpiler v0.9.2.
```bash
npm run gen-api -- -p qiskit-ibm-transpiler -v 0.9.2
```
---
docs/api/qiskit-ibm-transpiler/_package.json | 2 +-
..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 10 +-
...ranspiler.ai.AILinearFunctionSynthesis.mdx | 10 +-
...m_transpiler.ai.AIPermutationSynthesis.mdx | 10 +-
.../qiskit_ibm_transpiler.ai.AIRouting.mdx | 10 +-
...kit_ibm_transpiler.ai.CollectCliffords.mdx | 8 +-
...m_transpiler.ai.CollectLinearFunctions.mdx | 8 +-
..._ibm_transpiler.ai.CollectPermutations.mdx | 8 +-
...r.transpiler_service.TranspilerService.mdx | 2 +-
.../qiskit-ibm-transpiler/release-notes.mdx | 184 +++++++++---------
docs/api/qiskit-ibm-transpiler/utils.mdx | 4 +-
public/api/qiskit-ibm-transpiler/objects.inv | Bin 1087 -> 1087 bytes
12 files changed, 133 insertions(+), 123 deletions(-)
diff --git a/docs/api/qiskit-ibm-transpiler/_package.json b/docs/api/qiskit-ibm-transpiler/_package.json
index 78363eaec57..53ee715f552 100644
--- a/docs/api/qiskit-ibm-transpiler/_package.json
+++ b/docs/api/qiskit-ibm-transpiler/_package.json
@@ -1,4 +1,4 @@
{
"name": "qiskit-ibm-transpiler",
- "version": "0.9.1"
+ "version": "0.9.2"
}
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx
index 807c08c9ac0..893f8bb8c7d 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx
@@ -47,7 +47,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
**Parameters**
- **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run.
+ **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run.
**Raises**
@@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx
index c78207f6bdc..268ff2cba8a 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx
@@ -47,7 +47,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
**Parameters**
- **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run.
+ **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run.
**Raises**
@@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx
index b6315970fc8..eacf9500540 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx
@@ -47,7 +47,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
**Parameters**
- **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run.
+ **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run.
**Raises**
@@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx
index 2aa58e3a092..c16e5b94691 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx
@@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
# AIRouting
- Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)")
+ Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.3)")
The AIRouting pass acts both as a layout stage and a routing stage.
@@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -100,7 +100,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -109,7 +109,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx
index e53f0a81cf5..cd527a387c9 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx
index 50bdad2a87e..1fed97034e2 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx
index 751115a8885..b39e0bb0ac7 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx
@@ -52,7 +52,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
**Parameters**
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
+ * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself.
* **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.
**Returns**
@@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
**Return type**
- [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
+ [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*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")]
### name
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
**Parameters**
- * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
+ * **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**
@@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations
**Return type**
- [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
+ [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")
diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx
index edaafe10d55..e3ed0199ea1 100644
--- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx
+++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx
@@ -35,7 +35,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService
**Parameters**
- **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile.
+ **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – circuit(s) to transpile.
**Returns**
diff --git a/docs/api/qiskit-ibm-transpiler/release-notes.mdx b/docs/api/qiskit-ibm-transpiler/release-notes.mdx
index e9e3373c019..3d34746d113 100644
--- a/docs/api/qiskit-ibm-transpiler/release-notes.mdx
+++ b/docs/api/qiskit-ibm-transpiler/release-notes.mdx
@@ -10,13 +10,23 @@ in_page_toc_max_heading_level: 2
+## 0.9.2 (2024-12-12)
+
+### Bug fixes
+
+* Pin qiskit\_ibm\_ai\_local\_transpiler version to 0.1.3 ([145](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/145))
+
+
+
## 0.9.1 (2024-11-15)
+
+
### Bug fixes
* Fix optimization\_preferences\` used in generate\_ai\_pass\_manager method. Adding related tests ([130](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/130))
-
+
## 0.9.0 (2024-11-14)
@@ -24,32 +34,32 @@ in_page_toc_max_heading_level: 2
* Adding local mode for routing, permutations, linear functions and cliffords. ([125](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/125))
-
+
## 0.8.2 (2024-11-13)
-
+
### Bug fixes
* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105))
* Fix pauli better circuit replacement. ([122](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/122))
-
+
## 0.8.1 (2024-11-13)
-
+
### New features
* Updating the README to reflect the availability of the AIPauliNetworkSynthesis feature. ([121](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/121))
-
+
## 0.8.0 (2024-11-13)
-
+
### New features
@@ -58,51 +68,51 @@ in_page_toc_max_heading_level: 2
* Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111))
* Add Pauli Network synthesis pass. ([112](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/112))
-
+
## 0.7.4 (2024-11-11)
-
+
### New features
* Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104))
-
+
## 0.7.3 (2024-11-06)
-
+
### New features
* Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111))
-
+
## 0.7.2 (2024-10-31)
-
+
### Bug fixes
* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105))
-
+
## 0.7.1 (2024-10-30)
-
+
### New features
* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97))
-
+
## 0.7.0 (2024-09-18)
-
+
### New features
@@ -114,61 +124,61 @@ in_page_toc_max_heading_level: 2
* Removes unneeded benchmark method ([81](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/81))
* Adds test to verify that a circuit with a barrier will be transpiled ([84](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/84))
-
+
## 0.6.5 (2024-11-11)
-
+
### New features
* Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104))
-
+
## 0.6.4 (2024-11-07)
-
+
### New features
* Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111))
-
+
## 0.6.3 (2024-10-31)
-
+
### Bug fixes
* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105))
-
+
## 0.6.2 (2024-10-30)
-
+
### New features
* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97))
-
+
## 0.6.1 (2024-09-17)
-
+
### Bug fixes
* Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74))
-
+
## 0.6.0 (2024-09-16)
-
+
### New features
@@ -178,84 +188,84 @@ in_page_toc_max_heading_level: 2
* Enabling coupling\_map as options to the AI Synthesis passes ([70](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/70))
-
+
### Bug fixes
* Keep trying to get results even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52))
* Fixing the type of ECR gates when loading circuits from the Qiskit Transpiler Service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63))
-
+
## 0.5.7 (2024-11-11)
-
+
### New features
* Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104))
-
+
## 0.5.6 (2024-11-07)
-
+
### New features
* Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111))
-
+
## 0.5.5 (2024-10-31)
-
+
### Bug fixes
* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105))
-
+
## 0.5.4 (2024-10-30)
-
+
### New features
* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97))
-
+
## 0.5.3 (2024-09-17)
-
+
### Bug fixes
* Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74))
-
+
## 0.5.2 (2024-09-12)
-
+
### Bug fixes
* Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63))
-
+
## 0.5.1 (2024-08-29)
-
+
### Bug fixes
* Keep trying getting result even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52))
-
+
## 0.5.0 (2024-08-27)
@@ -263,47 +273,47 @@ in_page_toc_max_heading_level: 2
* Rename package to `qiskit-ibm-transpiler` ([43](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/43))
-
+
## 0.4.10 (2024-09-17)
-
+
### Bug fixes
* Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([77](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/77))
-
+
## 0.4.9 (2024-09-12)
-
+
### Bug fixes
* Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([64](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/64))
-
+
## 0.4.8 (2024-08-29)
-
+
### Bug fixes
* Keep trying getting result even in case of HTTPError exception with status 520 ([54](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/54))
-
+
## 0.4.7 (2024-08-27)
-
+
### Bug fixes
* Add stacklevel to DeprecationWarning so it appears in Jupyter notebooks ([49](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/49))
-
+
## 0.4.6 (2024-08-23)
@@ -311,179 +321,179 @@ in_page_toc_max_heading_level: 2
* Add deprecation notice in preparation for project rename to `qiskit-ibm-transpiler` ([40](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/40))
-
+
### Bug fixes
* Forward incoming error when decoding fails ([36](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/36))
-
+
## 0.4.5 (2024-08-01)
-
+
### New features
* Enable programmatic config of polling timeout ([28](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/28))
-
+
### Bug fixes
* Using the declared `ai_layout_mode` in the TranspilerService’s run method ([25](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/25))
-
+
## 0.4.4 (2024-07-25)
-
+
### Upgrade notes
* Increasing timeout to 600s instead of 120s ([21](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/21))
-
+
### New features
* Expose service errors to users ([8](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/8))
* Configure logging for a library ([10](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/10))
-
+
### Bug fixes
* Correctly parse string boolean for ai param ([7](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/7))
-
+
## 0.4.3 (2024-06-07)
-
+
### Upgrade notes
* Check existence of credentials and raise related exceptions instead of breaking
-
+
## 0.4.2 (2024-06-07)
-
+
### Bug fixes
* Python 3.8 support. Back to specify types with typing
* Fixing some import errors for local modules
-
+
### Other notes
* Relaxing pin of local dependencies
-
+
## 0.4.1 (2024-06-06)
-
+
### Upgrade notes
* Updating logs levels
-
+
### Bug fixes
* Rebuild layout in transpiled circuit
* Avoid barrier nodes in collection
-
+
### Other notes
* Refactoring the extension code
-
+
## 0.4.0 (2024-05-28)
-
+
### Upgrade notes
* Updating Clifford service URL
* Replace `use_ai` by `ai` param in requests
-
+
### New features
* Request the synthesis of a list of circuits to the service.
* Adding docstrings for public documentation
-
+
### Bug fixes
* Adjust dependencies to be less strict and support minor version updates for qiskit & patch updates for qiskit-qasm3-import
-
+
### Other notes
* Move type hints in documentation.
* Set name to logger
-
+
## 0.3.0 (2024-02-29)
-
+
### Upgrade notes
* Updating the plugin to use Qiskit 1.0 by default
-
+
### Bug fixes
* Supporting measurements in circuits when transpiling using `ai=true` option
-
+
## 0.2.1 (2024-02-22)
-
+
### New features
* Add multithreading to synth requests. The requests to the service for transpile and transpile now are done in parallel.
-
+
### Upgrade notes
* Updated collection passes. Now the passes could work up to N of qubits or with any block size of qubits.
-
+
## 0.2.0 (2024-02-12)
-
+
### New features
* Added support for synthesis and transpilation of Clifford, Permutation and Linear Function circuits. Using new URLs for the service.
-
+
## 0.1.3 (2023-12-11)
-
+
### Bug fixes
@@ -491,7 +501,7 @@ in_page_toc_max_heading_level: 2
* Fixing hardcoded input to routing
* Fix bug in input and refactor
-
+
## 0.1.2 (2023-12-04)
diff --git a/docs/api/qiskit-ibm-transpiler/utils.mdx b/docs/api/qiskit-ibm-transpiler/utils.mdx
index 8b6214c52fe..7a2058fb7c0 100644
--- a/docs/api/qiskit-ibm-transpiler/utils.mdx
+++ b/docs/api/qiskit-ibm-transpiler/utils.mdx
@@ -26,7 +26,7 @@ python_api_name: qiskit_ibm_transpiler.utils
**Return type**
- [*LinearFunction*](/api/qiskit/qiskit.circuit.library.LinearFunction "(in Qiskit v1.2)")
+ [*LinearFunction*](/api/qiskit/qiskit.circuit.library.LinearFunction "(in Qiskit v1.3)")
### get\_metrics
@@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_transpiler.utils
**Parameters**
- **qc** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) –
+ **qc** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) –
**Return type**
diff --git a/public/api/qiskit-ibm-transpiler/objects.inv b/public/api/qiskit-ibm-transpiler/objects.inv
index d289741bc3c66d7c896a4d591789f51307433cef..6bd1d0071af3b5cb9e84fb8a62ee51103e0d430c 100644
GIT binary patch
delta 968
zcmV;(12_D?2)_uBg@0dfn=ll`-}@;nbr0(UX}h=et?M)?(k6B5_KX~GT5DiZ+jPyh
zpCBQ@|M0zrH{@{d?*x2~4ZL#om+PEw>Rd}I)Q(q7t|%wF{axLZZNcUH8T^?$0FerZZ1?{a8>A)qxmoIUVxW*&j(`FDgz
zTXqnEap}N|8*}K6@Z!)sYQLd((p(=X;OYI)R23`qunmW;c}@`mfSdDnHDu~L#AF9J
zbc_*vGUoWfCkAN?M-to}4n1ZPhXwYEgNj(jAtgA+VPXwrZb4BtvP;phBuiO65XQ3U
zbM0j-Nq;bzN74dT^9V~boGlM+J6j3Rd^Q(rK^qG*qD@V=qs_;faj{?F=H;a|RG*ID?n&HiHbdT5%}mjhNU=
zW(#d5U0874%@$pFU9dk}vgN`>9-jj|51`rHCx1|NdZM2EUY0HQ!E8*7zP8Vnes4df
zPrvEQmV4EAKFk%9Z@gf}2Tk|q_yfJcu47o%VCdoO(@_lIY(pR%
qr^p@vQth1xf^C=jhk-hby$M2uQRf+(#DkWjs2ETeXXHP{-u^x@2GH{W
delta 968
zcmV;(12_D?2)_uBg@3_sn=ll{@BJ$*b%*sp+8)s(B+8kp#6w3KO)RaclZ&BvG~^9oQ8k
zd8#|gMN=}B&K);F^4ncWHOrNzx}BlGY%{6hI~R<~Z>=c0X@NDouQ~;ZHNU4#Tm<+u
z%m@OX9$Xwu2!ERw3KR0s(clw_2?(E_a7_5p0O~+Q!>^{*T)af4!Ekm=ORVRQWq)xt9~d*7J@9a59)aiicZ5e<
zb`XJa>A(vcbLfun;?O*3zoB>1TpuXW)BB;RDpu%W8y>gjIYkHnZqD1)F;m|mCOg2P
zV~haFnBxaX4AK^kqXNefsF5SC^*TOQhWwvtHm*<7pzZETzoZECt5Z9dkNqn#hhkwzU3ljOy5
z1B4L`?pzld8WJpMi&?;bwxl%k8N$%cGc-in&LCnvX8_|2XYkV9W{{(;Rve0XBPRBe
z*+QF17v^1evqcwP7Yt`hwp_T#<8uJ;0GiEx0)JJfC+f-XW!Z8c%*MpvYx`{J_x5A@
z^qanHxmSJX!(1`>&I@LI&~$$ef8ca$R=-a}&u7T=LKoF#j)ch2i)l3(fvx71GA?RA
z626Z8X{$oAF5@H>WmD%>KdtiZab9(8Psg{%#-WZcOy@Pzk{8NbPj|d*3Uy66QM$Y<
zn}4F4bd;0(HTmqDdsnA2E=u+>t~?AJ3NyZ`vvVQ2e_9jCwoEcnuu}_QVvhO&zy9o-
zll9jh#YA;+M*aiAz5YFGoX`RQ