search

quantumlib / Cirq

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

Out of date Quantum Engine API doc #6621

Open pavoljuhas opened 4 months ago

pavoljuhas commented 4 months ago

Description of the issue

docs/google/engine.md references the removed Engine.run_batch method. So does the API doc at the https://quantumai.google/cirq/google/engine.

Todo

Cirq version

1.4.0.dev at a9776d0f3613d675d68082aa620919a94658263c

shef4 commented 4 months ago

I'd like to be assigned this issue will start looking at engine.md

NoureldinYosri commented 4 months ago

cc: @senecameeks

shef4 commented 3 months ago

Hi, I started looking through engine.md and comparing the tutorial against the current Engine API.

From what I understood the difference between Engine.run vs Engine.run_batch is that Engine.run_batch accepts a list of circuits as input to process in bulk.

  1. Is there an alternative approach for running a list of circuits that should be used in the documentation instead?
  2. Would it make sense to use run_sweep() to replace Engine.run_batch in the tutorial?

I noticed that the run() function in the Engine class calls run_sweep(), which seemed to be a more generalized version that can return a list of results.

pavoljuhas commented 3 months ago

csynque meeting - it is better to reassign to cirq-google authors

github-actions[bot] commented 2 months ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 30 days

github-actions[bot] commented 1 month ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 30 days

github-actions[bot] commented 2 weeks ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 30 days