Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API dev docs #2254

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Update API dev docs #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/api/qiskit/dev/_toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1209,6 +1209,14 @@
"title": "FixedPoint",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint"
},
{
"title": "FullAdderSynthesisC04",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisC04"
},
{
"title": "FullAdderSynthesisV95",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95"
},
{
"title": "FullAncillaAllocation",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation"
Expand All @@ -1225,6 +1233,18 @@
"title": "GreedySynthesisClifford",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.GreedySynthesisClifford"
},
{
"title": "HalfAdderSynthesisC04",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisC04"
},
{
"title": "HalfAdderSynthesisD00",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisD00"
},
{
"title": "HalfAdderSynthesisV95",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95"
},
{
"title": "HighLevelSynthesis",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis"
Expand Down Expand Up @@ -1317,6 +1337,26 @@
"title": "MinimumPoint",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint"
},
{
"title": "ModularAdderSynthesisC04",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04"
},
{
"title": "ModularAdderSynthesisD00",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00"
},
{
"title": "ModularAdderSynthesisV95",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95"
},
{
"title": "MultiplierSynthesisH18",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisH18"
},
{
"title": "MultiplierSynthesisR17",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisR17"
},
{
"title": "NormalizeRXAngle",
"url": "/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle"
Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit/dev/circuit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,10 +598,10 @@ A circuit can contain manual classical storage locations, represented internally

Various parametric [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instances in Qiskit can be parametrized in ways that are designed to be resolved at compile time. These are characterized by the use of the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") and [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") classes.

| | |
| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name, \*\[, uuid]) | A compile-time symbolic parameter. |
| [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. |
| | |
| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name, \*\[, uuid]) | A compile-time symbolic parameter. |
| [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr, \*\[, ...]) | ParameterExpression class to enable creating expressions of Parameters. |

The main way that this differs from the `expr.Var` variables used in real-time classical computation is that [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") is a symbolic representation of a mathematical expression. The semantics of the expression are those of regular mathematics over the continuous real numbers (and, in limited cases, over the complex numbers). In contrast, [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") is a handle to a variable stored on a classical computer, such as a floating-point value or an fixed-width integer, which are always discrete.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/dev/compiler.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ python_api_name: qiskit.compiler

### transpile

<Function id="qiskit.compiler.transpile" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/compiler/transpiler.py#L43-L435" signature="qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None, qubits_initially_zero=True)">
<Function id="qiskit.compiler.transpile" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/compiler/transpiler.py#L43-L458" signature="qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None, qubits_initially_zero=True)">
Transpile one or more circuits, according to some desired transpilation targets.

Transpilation is potentially done in parallel using multiprocessing when `circuits` is a list with > 1 [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object, depending on the local environment and configuration.
Expand Down
50 changes: 43 additions & 7 deletions docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,19 @@ python_api_name: qiskit.circuit.EquivalenceLibrary

### graph

<Attribute id="qiskit.circuit.EquivalenceLibrary.graph" />
<Attribute id="qiskit.circuit.EquivalenceLibrary.graph">
Return graph representing the equivalence library data.

This property should be treated as read-only as it provides a reference to the internal state of the [`EquivalenceLibrary`](#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") object. If the graph returned by this property is mutated it could corrupt the the contents of the object. If you need to modify the output `PyDiGraph` be sure to make a copy prior to any modification.

**Returns**

A graph object with equivalence data in each node.

**Return type**

PyDiGraph
</Attribute>

## Methods

Expand Down Expand Up @@ -61,7 +73,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
### get\_entry

<Function id="qiskit.circuit.EquivalenceLibrary.get_entry" signature="get_entry(gate)">
Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate.
Gets the set of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instances circuits from the library which equivalently implement the given [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate").

Parameterized circuits will have their parameters replaced with the corresponding entries from Gate.params.

Expand All @@ -71,9 +83,9 @@ python_api_name: qiskit.circuit.EquivalenceLibrary

**Returns**

**A list of equivalent QuantumCircuits. If empty,**
**A list of equivalent [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instances.**

library contains no known decompositions of Gate.
If empty, library contains no known decompositions of Gate.

Returned circuits will be ordered according to their insertion in the library, from earliest to latest, from top to base. The ordering of the StandardEquivalenceLibrary will not generally be consistent across Qiskit versions.

Expand Down Expand Up @@ -104,11 +116,35 @@ python_api_name: qiskit.circuit.EquivalenceLibrary

### keys

<Function id="qiskit.circuit.EquivalenceLibrary.keys" signature="keys()" />
<Function id="qiskit.circuit.EquivalenceLibrary.keys" signature="keys()">
Return list of keys to key to node index map.

**Returns**

Keys to the key to node index map.

**Return type**

List
</Function>

### node\_index

<Function id="qiskit.circuit.EquivalenceLibrary.node_index" signature="node_index(key)" />
<Function id="qiskit.circuit.EquivalenceLibrary.node_index" signature="node_index(key)">
Return node index for a given key.

**Parameters**

**key** (*Key*) – Key to an equivalence.

**Returns**

Index to the node in the graph for the given key.

**Return type**

Int
</Function>

### set\_entry

Expand All @@ -120,7 +156,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
**Parameters**

* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – A Gate instance.
* **entry** (*List\['QuantumCircuit']*) – A list of QuantumCircuits, each equivalently implementing the given Gate.
* **entry** (*List\['QuantumCircuit']*) – A list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instances, each equivalently implementing the given Gate.
</Function>
</Class>

Loading