Cirq
Cirq copied to clipboard
Out of date Quantum Engine API doc
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
- [ ] sync engine.md with the actual API
- [ ] check for other instances referencing
Engine.run_batchor any other removed/deprecated functions
Cirq version
1.4.0.dev at a9776d0f3613d675d68082aa620919a94658263c
I'd like to be assigned this issue will start looking at engine.md
cc: @senecameeks
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.
- Is there an alternative approach for running a list of circuits that should be used in the documentation instead?
- Would it make sense to use
run_sweep()to replaceEngine.run_batchin 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.
csynque meeting - it is better to reassign to cirq-google authors
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
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
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
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