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

docs(aer_simulator.py): fixed typos #1828

Closed
wants to merge 4 commits into from

Conversation

alt-shreya
Copy link

Summary

fixes #1611
I removed two typos from the docs.
Next steps: list missing options and add them to the docs.

Details and comments

Will the following code help me check for missing functions?

for i in AerSimulator().available_methods():
    print(AerSimulator(method=i).options)

@CLAassistant
Copy link

CLAassistant commented May 26, 2023

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@alt-shreya
Copy link
Author

Following are the options that are not available on the documentation yet. Is there a definition for these options, or should I add one based on my understanding of Qiskit aer?

Automatic simulator options

shots
max_shot_size
fusion_enable
fusion_verbose
fusion_max_qubit
fusion_threshold
accept_distributed_results
noise_model
seed_simulator
blocking_qubits
chunk_swap_buffer_qubits
batched_shots_gpu
batched_shots_gpu_max_qubits
num_threads_per_device
statevector_parallel_threshold
statevector_sample_measure_opt
stabilizer_max_snapshot_probabilities
extended_stabilizer_sampling_method
extended_stabilizer_metropolis_mixing_time
extended_stabilizer_approximation_error
extended_stabilizer_norm_estimation_samples
extended_stabilizer_norm_estimation_repetitions
extended_stabilizer_parallel_threshold
extended_stabilizer_probabilities_snapshot_samples
matrix_product_state_truncation_threshold
matrix_product_state_max_bond_dimension
mps_sample_measure_algorithm
mps_log_data
mps_swap_direction
chop_threshold
mps_parallel_threshold
mps_omp_threads
tensor_network_num_sampling_qubits
use_cuTensorNet_autotuning

@hhorii hhorii added documentation Something is not clear or error in description stable-backport-potential The issue or PR might be minimal and/or import enough to backport to stable labels May 30, 2023
@hhorii hhorii added this to the Aer 0.12.1 milestone May 30, 2023
@hhorii
Copy link
Collaborator

hhorii commented Jun 1, 2023

Simulator options for automatic method do not need documentation. Aer determines a method based on characteristics of circuits and apply parameters of the method if they specified.

hhorii
hhorii previously approved these changes Jun 2, 2023
Copy link
Collaborator

@hhorii hhorii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution. This PR looks good to me.

@hhorii hhorii added automerge This PR will automatically merge once its CI has passed and removed automerge This PR will automatically merge once its CI has passed labels Jun 2, 2023
@hhorii
Copy link
Collaborator

hhorii commented Jun 5, 2023

Let me close this PR because other merged PR includes this typo with other fixes.

@hhorii hhorii closed this Jun 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or error in description stable-backport-potential The issue or PR might be minimal and/or import enough to backport to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some typos in qiskit_aer.AerSimulator docs
3 participants