quantumlib / Cirq

A Python framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
Apache License 2.0
4.3k stars 1.02k forks source link

cirq.Simulator.compute_amplitudes not well documented #2730

Closed karlunho closed 2 years ago

karlunho commented 4 years ago

We should add some documentation on how to use cirq.Simulator.compute_amplitudes . There is no documentation in https://cirq.readthedocs.io/en/stable/generated/cirq.Simulator.html , or in the simulator tutorial https://cirq.readthedocs.io/en/stable/simulation.html

kevinsung commented 4 years ago

The method is documented at https://cirq.readthedocs.io/en/stable/generated/cirq.Simulator.html: it's listed under "Methods", and clicking on it links to the full method documentation. Though it does look like that documentation could be expanded a bit.

As for adding it to the tutorial, I think it would make a much more compelling example once Cirq has a tensor network simulator that does not explicitly store the entire wavefunction.

MichaelBroughton commented 2 years ago

We've moved to new docs infra and this appears to have more complete docs now.