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

Out of date Quantum Engine API doc #6621

Open
2 tasks
pavoljuhas opened this issue May 29, 2024 · 8 comments
Open
2 tasks

Out of date Quantum Engine API doc #6621

pavoljuhas opened this issue May 29, 2024 · 8 comments
Assignees
Labels
kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add

Comments

@pavoljuhas
Copy link
Collaborator

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_batch or any other removed/deprecated functions

Cirq version

1.4.0.dev at a9776d0

@pavoljuhas pavoljuhas added kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests labels May 29, 2024
@shef4
Copy link
Contributor

shef4 commented May 31, 2024

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

@NoureldinYosri
Copy link
Collaborator

cc: @senecameeks

@shef4
Copy link
Contributor

shef4 commented Jun 6, 2024

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
Copy link
Collaborator Author

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

Copy link

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

Copy link

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

Copy link

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

Copy link

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

@NoureldinYosri NoureldinYosri added triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add and removed triage/stale labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add
Projects
None yet
Development

No branches or pull requests

4 participants