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

Regeneration of API docs with modifiers #1340

Merged
merged 41 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
2711030
Regenerate qiskit 0.24.1
arnaucasau May 10, 2024
d8e00be
Regenerate qiskit 0.25.4
arnaucasau May 10, 2024
423d828
Regenerate qiskit 0.26.2
arnaucasau May 10, 2024
4ccf9a8
Regenerate qiskit 0.27.0
arnaucasau May 10, 2024
6ea3e2f
Regenerate qiskit 0.28.0
arnaucasau May 10, 2024
23fd42f
Regenerate qiskit 0.29.1
arnaucasau May 10, 2024
b784950
Regenerate qiskit 0.30.1
arnaucasau May 10, 2024
edce048
Regenerate qiskit 0.31.0
arnaucasau May 10, 2024
e2d7b9a
Regenerate qiskit 0.32.1
arnaucasau May 10, 2024
509fd30
Regenerate qiskit 0.33.1
arnaucasau May 10, 2024
6943296
Regenerate qiskit 0.35.0
arnaucasau May 10, 2024
652f113
Regenerate qiskit 0.36.0
arnaucasau May 10, 2024
9d7d734
Regenerate qiskit 0.37.2
arnaucasau May 10, 2024
4f1a69e
Regenerate qiskit 0.38.0
arnaucasau May 10, 2024
29f6496
Regenerate qiskit 0.39.5
arnaucasau May 10, 2024
d93ea10
Regenerate qiskit 0.40.0
arnaucasau May 10, 2024
f61c49e
Regenerate qiskit 0.41.0
arnaucasau May 10, 2024
b28f875
Regenerate qiskit 0.42.0
arnaucasau May 10, 2024
96d9a49
Regenerate qiskit 0.43.0
arnaucasau May 10, 2024
8c8890f
Regenerate qiskit 0.44.0
arnaucasau May 10, 2024
7bab62e
Regenerate qiskit 0.45.3
arnaucasau May 10, 2024
ea08450
Regenerate qiskit 0.46.1
arnaucasau May 10, 2024
ff54d61
Regenerate qiskit 1.1.0rc1
arnaucasau May 10, 2024
e5d85db
Regenerate qiskit-ibm-runtime 0.14.0
arnaucasau May 10, 2024
1d6f0d6
Regenerate qiskit-ibm-runtime 0.15.0
arnaucasau May 10, 2024
74ece10
Regenerate qiskit-ibm-runtime 0.16.1
arnaucasau May 10, 2024
1368ac0
Regenerate qiskit-ibm-runtime 0.17.0
arnaucasau May 10, 2024
a96e846
Regenerate qiskit-ibm-runtime 0.18.0
arnaucasau May 10, 2024
a8e1a04
Regenerate qiskit-ibm-runtime 0.19.1
arnaucasau May 10, 2024
52b8ed6
Regenerate qiskit-ibm-runtime 0.20.0
arnaucasau May 10, 2024
1187d3f
Regenerate qiskit-ibm-runtime 0.21.1
arnaucasau May 10, 2024
eb37e86
Regenerate qiskit-ibm-runtime 0.22.0
arnaucasau May 10, 2024
bd84c1c
Regenerate qiskit-ibm-runtime 0.23.0
arnaucasau May 10, 2024
c9ba493
Regenerate qiskit-ibm-runtime 0.24.0-dev
arnaucasau May 10, 2024
a00f910
Regenerate qiskit-ibm-provider 0.10.0
arnaucasau May 10, 2024
24fc85d
Regenerate qiskit-ibm-provider 0.7.3
arnaucasau May 10, 2024
32baf04
Regenerate qiskit-ibm-provider 0.8.0
arnaucasau May 10, 2024
a3dd20e
Regenerate qiskit-ibm-provider 0.9.0
arnaucasau May 10, 2024
898627c
Regenerate qiskit-ibm-provider 0.11.0
arnaucasau May 10, 2024
2ca2218
Regenerate qiskit-transpiler-service 0.3.0
arnaucasau May 10, 2024
62131f6
Regenerate qiskit 0.19.6
arnaucasau May 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.24/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ python_api_name: qiskit.ignis.logging

### IgnisLogger

<Class id="qiskit.ignis.logging.IgnisLogger" github="https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py" signature="IgnisLogger(name, level=0)">
<Class id="qiskit.ignis.logging.IgnisLogger" github="https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py" signature="IgnisLogger(name, level=0)" modifiers="class">
A logger class for Ignis

IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.24/qiskit.aqua.AquaError.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError

# qiskit.aqua.AquaError

<Class id="qiskit.aqua.AquaError" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/aqua_error.py" signature="AquaError(*message)">
<Class id="qiskit.aqua.AquaError" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/aqua_error.py" signature="AquaError(*message)" modifiers="exception">
Base class for errors raised by Aqua.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError

# qiskit.aqua.MissingOptionalLibraryError

<Class id="qiskit.aqua.MissingOptionalLibraryError" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/missing_optional_library_error.py" signature="MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)">
<Class id="qiskit.aqua.MissingOptionalLibraryError" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/missing_optional_library_error.py" signature="MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)" modifiers="exception">
Raised when an optional library is missing.

Set the error message.
Expand Down
34 changes: 17 additions & 17 deletions docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance

# qiskit.aqua.QuantumInstance

<Class id="qiskit.aqua.QuantumInstance" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/quantum_instance.py" signature="QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)">
<Class id="qiskit.aqua.QuantumInstance" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/quantum_instance.py" signature="QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)" modifiers="class">
Quantum Backend including execution setting.

Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance.
Expand Down Expand Up @@ -122,25 +122,25 @@ python_api_name: qiskit.aqua.QuantumInstance

### backend

<Function id="qiskit.aqua.QuantumInstance.backend" signature="property backend">
<Function id="qiskit.aqua.QuantumInstance.backend" signature="backend" modifiers="property">
Return BaseBackend backend object.
</Function>

### backend\_config

<Function id="qiskit.aqua.QuantumInstance.backend_config" signature="property backend_config">
<Function id="qiskit.aqua.QuantumInstance.backend_config" signature="backend_config" modifiers="property">
Getter of backend\_config.
</Function>

### backend\_name

<Function id="qiskit.aqua.QuantumInstance.backend_name" signature="property backend_name">
<Function id="qiskit.aqua.QuantumInstance.backend_name" signature="backend_name" modifiers="property">
Return backend name.
</Function>

### backend\_options

<Function id="qiskit.aqua.QuantumInstance.backend_options" signature="property backend_options">
<Function id="qiskit.aqua.QuantumInstance.backend_options" signature="backend_options" modifiers="property">
Getter of backend\_options.
</Function>

Expand Down Expand Up @@ -168,19 +168,19 @@ python_api_name: qiskit.aqua.QuantumInstance

### cals\_matrix\_refresh\_period

<Function id="qiskit.aqua.QuantumInstance.cals_matrix_refresh_period" signature="property cals_matrix_refresh_period">
<Function id="qiskit.aqua.QuantumInstance.cals_matrix_refresh_period" signature="cals_matrix_refresh_period" modifiers="property">
returns matrix refresh period
</Function>

### circuit\_summary

<Function id="qiskit.aqua.QuantumInstance.circuit_summary" signature="property circuit_summary">
<Function id="qiskit.aqua.QuantumInstance.circuit_summary" signature="circuit_summary" modifiers="property">
Getter of circuit summary.
</Function>

### compile\_config

<Function id="qiskit.aqua.QuantumInstance.compile_config" signature="property compile_config">
<Function id="qiskit.aqua.QuantumInstance.compile_config" signature="compile_config" modifiers="property">
Getter of compile\_config.
</Function>

Expand Down Expand Up @@ -209,19 +209,19 @@ python_api_name: qiskit.aqua.QuantumInstance

### is\_local

<Function id="qiskit.aqua.QuantumInstance.is_local" signature="property is_local">
<Function id="qiskit.aqua.QuantumInstance.is_local" signature="is_local" modifiers="property">
Return True if backend is a local backend.
</Function>

### is\_simulator

<Function id="qiskit.aqua.QuantumInstance.is_simulator" signature="property is_simulator">
<Function id="qiskit.aqua.QuantumInstance.is_simulator" signature="is_simulator" modifiers="property">
Return True if backend is a simulator.
</Function>

### is\_statevector

<Function id="qiskit.aqua.QuantumInstance.is_statevector" signature="property is_statevector">
<Function id="qiskit.aqua.QuantumInstance.is_statevector" signature="is_statevector" modifiers="property">
Return True if backend is a statevector-type simulator.
</Function>

Expand All @@ -241,31 +241,31 @@ python_api_name: qiskit.aqua.QuantumInstance

### measurement\_error\_mitigation\_cls

<Function id="qiskit.aqua.QuantumInstance.measurement_error_mitigation_cls" signature="property measurement_error_mitigation_cls">
<Function id="qiskit.aqua.QuantumInstance.measurement_error_mitigation_cls" signature="measurement_error_mitigation_cls" modifiers="property">
returns measurement error mitigation cls
</Function>

### measurement\_error\_mitigation\_shots

<Function id="qiskit.aqua.QuantumInstance.measurement_error_mitigation_shots" signature="property measurement_error_mitigation_shots">
<Function id="qiskit.aqua.QuantumInstance.measurement_error_mitigation_shots" signature="measurement_error_mitigation_shots" modifiers="property">
returns measurement error mitigation shots
</Function>

### noise\_config

<Function id="qiskit.aqua.QuantumInstance.noise_config" signature="property noise_config">
<Function id="qiskit.aqua.QuantumInstance.noise_config" signature="noise_config" modifiers="property">
Getter of noise\_config.
</Function>

### qjob\_config

<Function id="qiskit.aqua.QuantumInstance.qjob_config" signature="property qjob_config">
<Function id="qiskit.aqua.QuantumInstance.qjob_config" signature="qjob_config" modifiers="property">
Getter of qjob\_config.
</Function>

### run\_config

<Function id="qiskit.aqua.QuantumInstance.run_config" signature="property run_config">
<Function id="qiskit.aqua.QuantumInstance.run_config" signature="run_config" modifiers="property">
Getter of run\_config.
</Function>

Expand All @@ -277,7 +277,7 @@ python_api_name: qiskit.aqua.QuantumInstance

### skip\_qobj\_validation

<Function id="qiskit.aqua.QuantumInstance.skip_qobj_validation" signature="property skip_qobj_validation">
<Function id="qiskit.aqua.QuantumInstance.skip_qobj_validation" signature="skip_qobj_validation" modifiers="property">
checks if skip qobj validation
</Function>

Expand Down
20 changes: 10 additions & 10 deletions docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation

# qiskit.aqua.algorithms.AmplitudeEstimation

<Class id="qiskit.aqua.algorithms.AmplitudeEstimation" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py" signature="AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)">
<Class id="qiskit.aqua.algorithms.AmplitudeEstimation" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py" signature="AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)" modifiers="class">
The Quantum Phase Estimation-based Amplitude Estimation algorithm.

This class implements the original Quantum Amplitude Estimation (QAE) algorithm, introduced by \[1]. This canonical version uses quantum phase estimation along with a set of $m$ additional evaluation qubits to find an estimate $\tilde{a}$, that is restricted to the grid
Expand Down Expand Up @@ -93,7 +93,7 @@ $$

### a\_factory

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.a_factory" signature="property a_factory">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.a_factory" signature="a_factory" modifiers="property">
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
Get the A operator encoding the amplitude a that’s approximated, i.e.

> A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1>
Expand All @@ -111,7 +111,7 @@ $$

### backend

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.backend" signature="property backend">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.backend" signature="backend" modifiers="property">
Returns backend.

**Return type**
Expand Down Expand Up @@ -163,7 +163,7 @@ $$

### grover\_operator

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.grover_operator" signature="property grover_operator">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.grover_operator" signature="grover_operator" modifiers="property">
Get the $\mathcal{Q}$ operator, or Grover operator.

If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers.
Expand All @@ -179,7 +179,7 @@ $$

### i\_objective

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.i_objective" signature="property i_objective">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.i_objective" signature="i_objective" modifiers="property">
Get the index of the objective qubit. The objective qubit marks the |psi\_0> state (called ‘bad states’ in [https://arxiv.org/abs/quant-ph/0005055](https://arxiv.org/abs/quant-ph/0005055)) with |0> and |psi\_1> (‘good’ states) with |1>. If the A operator performs the mapping

> A |0>\_n |0> = sqrt\{1 - a} |psi\_0>\_n |0> + sqrt\{a} |psi\_1>\_n |1>
Expand Down Expand Up @@ -221,7 +221,7 @@ $$

### objective\_qubits

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.objective_qubits" signature="property objective_qubits">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.objective_qubits" signature="objective_qubits" modifiers="property">
Get the criterion for a measurement outcome to be in a ‘good’ state.

**Return type**
Expand Down Expand Up @@ -253,7 +253,7 @@ $$

### q\_factory

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.q_factory" signature="property q_factory">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.q_factory" signature="q_factory" modifiers="property">
Get the Q operator, or Grover-operator for the Amplitude Estimation algorithm, i.e.

$$
Expand All @@ -275,7 +275,7 @@ $$

### quantum\_instance

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.quantum_instance" signature="property quantum_instance">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.quantum_instance" signature="quantum_instance" modifiers="property">
Returns quantum instance.

**Return type**
Expand All @@ -285,7 +285,7 @@ $$

### random

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.random" signature="property random">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.random" signature="random" modifiers="property">
Return a numpy random.
</Function>

Expand Down Expand Up @@ -324,7 +324,7 @@ $$

### state\_preparation

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.state_preparation" signature="property state_preparation">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.state_preparation" signature="state_preparation" modifiers="property">
Get the $\mathcal{A}$ operator encoding the amplitude $a$.

**Return type**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

# qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

<Class id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py" signature="AmplitudeEstimationAlgorithmResult(a_dict=None)">
<Class id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py" signature="AmplitudeEstimationAlgorithmResult(a_dict=None)" modifiers="class">
AmplitudeEstimationAlgorithm Result.

### \_\_init\_\_
Expand Down Expand Up @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### a\_estimation

<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.a_estimation" signature="property a_estimation">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.a_estimation" signature="a_estimation" modifiers="property">
return a\_estimation

**Return type**
Expand Down Expand Up @@ -81,7 +81,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### confidence\_interval

<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.confidence_interval" signature="property confidence_interval">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.confidence_interval" signature="confidence_interval" modifiers="property">
return confidence\_interval

**Return type**
Expand All @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### estimation

<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.estimation" signature="property estimation">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.estimation" signature="estimation" modifiers="property">
return estimation

**Return type**
Expand All @@ -101,7 +101,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### from\_dict

<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.from_dict" signature="static from_dict(a_dict)">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.from_dict" signature="from_dict(a_dict)" modifiers="static">
create new object from a dictionary

**Return type**
Expand All @@ -123,7 +123,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### num\_oracle\_queries

<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.num_oracle_queries" signature="property num_oracle_queries">
<Function id="qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.num_oracle_queries" signature="num_oracle_queries" modifiers="property">
return num\_oracle\_queries

**Return type**
Expand Down
Loading