Skip to content

Add return-type description for cirq.sample #5649

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

Merged
95-martin-orion merged 3 commits into from
Jul 6, 2022
+3 −0
Merged

Add return-type description for cirq.sample #5649

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
831cb29
Add return-type description for `cirq.sample`
95-martin-orion Jun 29, 2022
45fc7be
Merge branch 'master' into sample-returns-docs
dabacon Jun 30, 2022
d5ef6a6
Merge branch 'master' into sample-returns-docs
95-martin-orion Jul 6, 2022
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
3 changes: 3 additions & 0 deletions cirq-core/cirq/sim/mux.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ def sample(
`numpy.complex64` or `numpy.complex128`.
Favors speed over precision by default, i.e. uses `numpy.complex64`.
seed: The random seed to use for this simulator.

Returns:
A `cirq.Result` object containing the requested measurement samples.
"""
noise_model = devices.NoiseModel.from_noise_model_like(noise)

Expand Down