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.

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

Improve function handling #683

Merged
merged 12 commits into from
Jan 25, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The error map figure.
* **VisualizationValueError** – If an invalid input is received.
* **VisualizationTypeError** – If the specified backend is a simulator.

## Example
**Example**

```python
from qiskit_ibm_provider import IBMProvider
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Plots an interactive gate map of a device.

The gate map figure.

## Example
**Example**

```python
from qiskit_ibm_provider import IBMProvider
Expand Down
4 changes: 4 additions & 0 deletions docs/api/qiskit/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ Utility classes used by algorithms (mainly for type-hinting purposes).

Utility functions used by algorithms.

### eval\_observables

<span id="qiskit.algorithms.eval_observables" />

`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/aux_ops_evaluator.py "view source code")
Expand Down Expand Up @@ -245,6 +247,8 @@ A list or a dictionary of tuples (mean, standard deviation).

ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)"), [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)")]]

### estimate\_observables

<span id="qiskit.algorithms.estimate_observables" />

`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/observables_evaluator.py "view source code")
Expand Down
12 changes: 9 additions & 3 deletions docs/api/qiskit/assembler.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ python_api_name: qiskit.assembler

## Circuit Assembler

### assemble\_circuits

<span id="qiskit.assembler.assemble_circuits" />

`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_circuits.py "view source code")
Expand All @@ -41,7 +43,7 @@ The qobj to be run on the backends

[*QasmQobj*](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj")

## Examples
**Examples**

```python
from qiskit.circuit import QuantumRegister, ClassicalRegister, QuantumCircuit
Expand All @@ -63,6 +65,8 @@ qobj = assemble_circuits(circuits=[qc],

## Schedule Assembler

### assemble\_schedules

<span id="qiskit.assembler.assemble_schedules" />

`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_schedules.py "view source code")
Expand All @@ -88,7 +92,7 @@ The Qobj to be run on the backends.

[*PulseQobj*](qiskit.qobj.PulseQobj "qiskit.qobj.pulse_qobj.PulseQobj")

## Examples
**Examples**

```python
from qiskit import pulse
Expand Down Expand Up @@ -127,6 +131,8 @@ pulseQobj = assemble_schedules(schedules=[schedule],

## Disassembler

### disassemble

<span id="qiskit.assembler.disassemble" />

`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code")
Expand All @@ -153,7 +159,7 @@ The disassembled program which consists of:

Union\[CircuitModule, PulseModule]

## Examples
**Examples**

```python
from qiskit.circuit import QuantumRegister, ClassicalRegister, QuantumCircuit
Expand Down
2 changes: 2 additions & 0 deletions docs/api/qiskit/circuit.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,8 @@ with qc.switch(cr) as case:

### Random Circuits

### random\_circuit

<span id="qiskit.circuit.random.random_circuit" />

`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/random/utils.py "view source code")
Expand Down
Loading