Skip to content

Commit

Permalink
Regenerate qiski 1.3.1 API docs (#2563)
Browse files Browse the repository at this point in the history
This PR regenerates the qiskit 1.3.1 API docs. It incorporates fixes in
the documentation like the alt text in all the images except the release
notes.
  • Loading branch information
arnaucasau authored Jan 10, 2025
1 parent 21acdd0 commit b54ddb9
Show file tree
Hide file tree
Showing 354 changed files with 690 additions and 727 deletions.
10 changes: 5 additions & 5 deletions docs/api/qiskit/circuit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ circ.cx(0, 2)
circ.draw('mpl')
```

![../\_images/circuit-1.png](/images/api/qiskit/circuit-1.png)
![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-1.png)

<span id="circuit-definitions" />

Expand Down Expand Up @@ -896,7 +896,7 @@ Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](

#### random\_circuit

<Function id="qiskit.circuit.random.random_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/random/utils.py#L24-L288" signature="qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None, num_operand_distribution=None)">
<Function id="qiskit.circuit.random.random_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/random/utils.py#L24-L289" signature="qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None, num_operand_distribution=None)">
Generate random circuit of arbitrary size and form.

This function will generate a random circuit by randomly selecting gates from the set of standard gates in `qiskit.circuit.library.standard_gates`. For example:
Expand All @@ -908,7 +908,7 @@ Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](
circ.draw(output='mpl')
```

![../\_images/circuit-2.png](/images/api/qiskit/circuit-2.png)
![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-2.png)

**Parameters**

Expand Down Expand Up @@ -1027,7 +1027,7 @@ If we draw this circuit, we will see that Qiskit places the zeroth qubit on the
qc.draw("mpl")
```

![../\_images/circuit-4.png](/images/api/qiskit/circuit-4.png)
![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-4.png)

### Matrix representations

Expand All @@ -1038,7 +1038,7 @@ $$
\leftrightarrow \begin{pmatrix} \alpha \\ \beta \end{pmatrix}
$$

where $\alpha$ and $\beta$ are complex numbers. We store the statevector as a 1D Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") with data `sv = [alpha, beta]`, *i.e.* `sv[0] == alpha` and `sv[1] == beta`; note that the indices into the statevector match the ket labels.
where $\alpha$ and $\beta$ are complex numbers. We store the statevector as a 1D Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.2)") with data `sv = [alpha, beta]`, *i.e.* `sv[0] == alpha` and `sv[1] == beta`; note that the indices into the statevector match the ket labels.

We construct [the tensor product of two qubit states](https://en.wikipedia.org/wiki/Tensor_product) in matrix algebra using [the Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product), with qubit 0 on the right and qubit 1 on the left, such that the $Z$ basis state $\lvert x\rangle$ (where $x$ is the integer interpretation of the bitstring) has its non-zero term in the statevector `sv` at `sv[x]`:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/circuit_library.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ circuit.append(gate, [0, 1, 4, 2, 3])
circuit.draw('mpl')
```

![../\_images/circuit\_library-1.png](/images/api/qiskit/circuit_library-1.png)
![Circuit diagram output by the previous code.](/images/api/qiskit/circuit_library-1.png)

The library is organized in several sections. The function [`get_standard_gate_name_mapping()`](#qiskit.circuit.library.get_standard_gate_name_mapping "qiskit.circuit.library.get_standard_gate_name_mapping") allows you to see the available standard gates and operations.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/converters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ python_api_name: qiskit.converters

### dag\_to\_circuit

<Function id="qiskit.converters.dag_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/converters/dag_to_circuit.py#L19-L79" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
<Function id="qiskit.converters.dag_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/converters/dag_to_circuit.py#L19-L80" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
Build a `QuantumCircuit` object from a `DAGCircuit`.

**Parameters**
Expand Down Expand Up @@ -175,7 +175,7 @@ python_api_name: qiskit.converters
circuit.draw('mpl')
```

![../\_images/converters-1.png](/images/api/qiskit/converters-1.png)
![Circuit diagram output by the previous code.](/images/api/qiskit/converters-1.png)
</Function>

<span id="quantumcircuit-dagdependency" />
Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/providers_fake_provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ counts = job.result().get_counts()
plot_histogram(counts)
```

![../\_images/providers\_fake\_provider-1\_00.png](/images/api/qiskit/providers_fake_provider-1_00.png)
![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_00.png)

![../\_images/providers\_fake\_provider-1\_01.png](/images/api/qiskit/providers_fake_provider-1_01.png)
![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_01.png)

![../\_images/providers\_fake\_provider-1\_02.png](/images/api/qiskit/providers_fake_provider-1_02.png)
![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_02.png)

## V2 Simulated Backends

Expand Down
Loading

0 comments on commit b54ddb9

Please sign in to comment.