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

Explaining Engine API access #3337

Merged
merged 3 commits into from Sep 18, 2020

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Sep 17, 2020

More explanation around the Engine API.

@googlebot googlebot added the cla: yes Makes googlebot stop complaining. label Sep 17, 2020
Copy link
Collaborator

@karlunho karlunho left a 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.
Copy link
Collaborator

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"

Copy link
Contributor Author

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

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))


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

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.

@balopat
Copy link
Contributor Author

balopat commented Sep 18, 2020

Looks great. It might be useful to mention that we have weekly open meeting to review proposals.

I added the RFC process as an alternative to mailing the maintainers, that should cover the meeting review as well.

@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Sep 18, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Sep 18, 2020
@CirqBot CirqBot merged commit 64939e5 into quantumlib:master Sep 18, 2020
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Sep 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants