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

Fix the properties that were incorrectly marked as methods in Qiskit 0.24-0.28 #1387

Merged
merged 6 commits into from
May 15, 2024
Merged

Fix the properties that were incorrectly marked as methods in Qiskit 0.24-0.28 #1387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eda9c3b
Fix apiType for historical properties
arnaucasau May 15, 2024
cdf1a7f
Regenerate qiskit 0.24.1
arnaucasau May 15, 2024
6c9b901
Regenerate qiskit 0.25.4
arnaucasau May 15, 2024
05151bd
Regenerate qiskit 0.26.2
arnaucasau May 15, 2024
e70bd4e
Regenerate qiskit 0.27.0
arnaucasau May 15, 2024
783d33f
Regenerate qiskit 0.28.0
arnaucasau May 15, 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
  •  
  •  
  •  
64 changes: 32 additions & 32 deletions docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,27 +122,27 @@ python_api_name: qiskit.aqua.QuantumInstance

### backend

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

### backend\_config

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

### backend\_name

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

### backend\_options

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

### cals\_matrix

Expand All @@ -168,21 +168,21 @@ python_api_name: qiskit.aqua.QuantumInstance

### cals\_matrix\_refresh\_period

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

### circuit\_summary

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

### compile\_config

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

### execute

Expand All @@ -209,21 +209,21 @@ python_api_name: qiskit.aqua.QuantumInstance

### is\_local

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

### is\_simulator

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

### is\_statevector

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

### maybe\_refresh\_cals\_matrix

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

### measurement\_error\_mitigation\_cls

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

### measurement\_error\_mitigation\_shots

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

### noise\_config

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

### qjob\_config

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

### run\_config

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

### set\_config

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

### skip\_qobj\_validation

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

### transpile

Expand Down
36 changes: 18 additions & 18 deletions docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ $$

### a\_factory

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.a_factory" signature="a_factory" modifiers="property">
<Attribute id="qiskit.aqua.algorithms.AmplitudeEstimation.a_factory">
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 @@ -107,17 +107,17 @@ $$
**Return type**

[CircuitFactory](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory")
</Function>
</Attribute>

### backend

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

**Return type**

`Union`\[`Backend`, `BaseBackend`]
</Function>
</Attribute>

### confidence\_interval

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

### grover\_operator

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.grover_operator" signature="grover_operator" modifiers="property">
<Attribute id="qiskit.aqua.algorithms.AmplitudeEstimation.grover_operator">
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 @@ -175,11 +175,11 @@ $$
**Returns**

The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set.
</Function>
</Attribute>

### i\_objective

<Function id="qiskit.aqua.algorithms.AmplitudeEstimation.i_objective" signature="i_objective" modifiers="property">
<Attribute id="qiskit.aqua.algorithms.AmplitudeEstimation.i_objective">
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 All @@ -195,7 +195,7 @@ $$
**Return type**

int
</Function>
</Attribute>

### is\_good\_state

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

### objective\_qubits

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

**Return type**
Expand All @@ -231,7 +231,7 @@ $$
**Returns**

The criterion as list of qubit indices.
</Function>
</Attribute>

### post\_processing

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

### q\_factory

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

$$
Expand All @@ -271,23 +271,23 @@ $$
**Return type**

QFactory
</Function>
</Attribute>

### quantum\_instance

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

**Return type**

`Optional`\[`QuantumInstance`]
</Function>
</Attribute>

### random

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

### run

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

### state\_preparation

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

**Return type**
Expand All @@ -334,6 +334,6 @@ $$
**Returns**

The $\mathcal{A}$ operator as QuantumCircuit.
</Function>
</Attribute>
</Class>

16 changes: 8 additions & 8 deletions docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### a\_estimation

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

**Return type**

`float`
</Function>
</Attribute>

### clear

Expand All @@ -81,23 +81,23 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### confidence\_interval

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

**Return type**

`List`\[`float`]
</Function>
</Attribute>

### estimation

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

**Return type**

`float`
</Function>
</Attribute>

### from\_dict

Expand All @@ -123,13 +123,13 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult

### num\_oracle\_queries

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

**Return type**

`int`
</Function>
</Attribute>

### pop

Expand Down
Loading
Loading