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
Explaining Engine API access #3337
Explaining Engine API access #3337
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. It might be useful to mention that we have weekly open meeting to review proposals.
to access or manage the jobs, programs, reservations and calibrations. Cirq is | ||
the only supported client for this API, using the `cirq.google.Engine` class. | ||
|
||
Note: the Quantum Engine API is not yet open for public access. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add timestamp to "not yet"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting idea - I'm guessing you're trying to avoid the situation where we open up the doors, and then this will be forgotten and will be weird?
But what you're suggesting (timestamp / date) gets outdated immediately - i.e. for 9/15/2020 it will raise questions in the heads of users in November - is this still accurate? So to avoid that, we'd need to update these timestamps at least monthly? I'm not convinced yet about timestamping. I think when we open the doors, we'll have a big revamp anyway and make sure the user journey's make sense, minimizing the risk of the failure scenario above.
Google's Quantum Computing Service provides the Quantum Engine API to execute | ||
circuits on Google's quantum processor or simulator backends and | ||
to access or manage the jobs, programs, reservations and calibrations. Cirq is | ||
the only supported client for this API, using the `cirq.google.Engine` class. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(maybe timestamp this statement, i.e. currently (as of XX))
docs/google/engine.md
Outdated
|
||
Note: the Quantum Engine API is not yet open for public access. | ||
|
||
Note: while Cirq is the only supported way of using to the API currently, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: It's slightly awkward to have two "Note:" in a row. Maybe move this note up to the previous paragraph and condense it, such as:
Cirq is the only supported client for this API, using the cirq.google.Engine
class. For other use cases (e.g. from a different language), contact cirq-maintainers@googlegroups.com with a proposal.
I added the RFC process as an alternative to mailing the maintainers, that should cover the meeting review as well. |
More explanation around the Engine API.