Skip to content

Commit

Permalink
Generate qiskit-ibm-transpiler 0.9.2 API docs (#2467)
Browse files Browse the repository at this point in the history
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
```
  • Loading branch information
arnaucasau authored Dec 12, 2024
1 parent 047d81e commit 05b9223
Show file tree
Hide file tree
Showing 12 changed files with 133 additions and 123 deletions.
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-transpiler/_package.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "qiskit-ibm-transpiler",
"version": "0.9.1"
"version": "0.9.2"
}
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand All @@ -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**

Expand All @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand All @@ -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**

Expand All @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand All @@ -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**

Expand All @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting
# AIRouting

<Class id="qiskit_ibm_transpiler.ai.AIRouting" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-transpiler/tree/stable/0.9/qiskit_ibm_transpiler/ai/routing.py#L100-L289" signature="qiskit_ibm_transpiler.ai.AIRouting(backend_name: str | None = None, coupling_map: list[list[int]] | None = None, optimization_level: int = 2, layout_mode: str = 'OPTIMIZE')" modifiers="class">
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.

Expand Down Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand Down Expand Up @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand Down Expand Up @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand Down Expand Up @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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)")]
</Function>

### name
Expand Down Expand Up @@ -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**
Expand All @@ -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)")
</Function>
</Class>

Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
Loading

0 comments on commit 05b9223

Please sign in to comment.