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 typos in aer_simulator, qasm_simulator docs #1833

Merged
merged 3 commits into from
Jun 5, 2023
Merged

Fix typos in aer_simulator, qasm_simulator docs #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
298a986
Fix typos.
TerraVenil May 28, 2023
54ffa62
Add missing aer_simulator options.
TerraVenil May 28, 2023
437a5ba
Update reference to SaveProbabilities according comment to PR.
TerraVenil Jun 1, 2023
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
15 changes: 11 additions & 4 deletions qiskit_aer/backends/aer_simulator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,6 @@ class AerSimulator(AerBackend):
qubits which do not affect the simulation outcome from the simulated
circuits (Default: True).


* ``zero_threshold`` (double): Sets the threshold for truncating
small values to zero in the result data (Default: 1e-10).

Expand Down Expand Up @@ -288,6 +287,9 @@ class AerSimulator(AerBackend):
threads per GPU. This parameter is used to optimize Pauli noise
simulation with multiple-GPUs (Default: 1).

* ``accept_distributed_results`` (bool): This option enables storing
results independently in each process (Default: None).

These backend options only apply when using the ``"statevector"``
simulation method:

Expand All @@ -308,9 +310,7 @@ class AerSimulator(AerBackend):
simulation method:

* ``stabilizer_max_snapshot_probabilities`` (int): set the maximum
qubit number for the
`~qiskit_aer.extensions.SnapshotProbabilities`
instruction (Default: 32).
qubit number for the :class:`~qiskit_aer.library.SaveProbabilities` instruction (Default: 32).

These backend options only apply when using the ``"extended_stabilizer"``
simulation method:
Expand Down Expand Up @@ -407,6 +407,13 @@ class AerSimulator(AerBackend):
Possible values are "mps_swap_right" and "mps_swap_left".
(Default: "mps_swap_left")

* ``chop_threshold`` (float): This option sets a threshold for
truncating snapshots (Default: 1e-8).

* ``mps_parallel_threshold`` (int): This option sets OMP number threshold (Default: 14).

* ``mps_omp_threads`` (int): This option sets the number of OMP threads (Default: 1).

These backend options only apply when using the ``tensor_network``
simulation method:

Expand Down
4 changes: 1 addition & 3 deletions qiskit_aer/backends/qasm_simulator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,7 @@ class QasmSimulator(AerBackend):
simulation method:

* ``stabilizer_max_snapshot_probabilities`` (int): set the maximum
qubit number for the
`~qiskit_aer.extensions.SnapshotProbabilities`
instruction (Default: 32).
qubit number for the :class:`~qiskit_aer.library.SaveProbabilities` instruction (Default: 32).

These backend options only apply when using the ``"extended_stabilizer"``
simulation method:
Expand Down