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

Update the lattices used in the documentation #47

Open
antalszava opened this issue Mar 31, 2020 · 3 comments
Open

Update the lattices used in the documentation #47

antalszava opened this issue Mar 31, 2020 · 3 comments

Comments

@antalszava
Copy link
Contributor

The lattices used when creating a device based on the documentation seem to be outdated. For example:

>>> dev_qpu = qml.device('forest.qpu', device='Aspen-0-12Q-A', shots=1000)
  File "/anaconda3/lib/python3.7/site-packages/pyquil/api/_devices.py", line 147, in _get_raw_lattice_data
    res = get_json(session, f"{config.forest_url}/lattices/{lattice_name}")
  File "/anaconda3/lib/python3.7/site-packages/pyquil/api/_base_connection.py", line 54, in get_json
    raise parse_error(res)
pyquil.api._errors.UnknownApiError: Lattice with name 'Aspen-0-12Q-A' not found.

This is true for multiple lattices used on the Usage page when creating a device.

@josh146
Copy link
Member

josh146 commented Mar 31, 2020

Hmm, I'm not sure what the most satisfying solution is here. We could:

  1. Update the lattice name, but then there is a maintenance overhead

  2. Add a disclaimer below the codeblock

@antalszava
Copy link
Contributor Author

Yes, perhaps having option 2 to instruct the user to change the lattice name to one that is available based on the output of

import pyquil
pyquil.list_quantum_computers()

could be helpful. And then having a placeholder for the name could also be good because then the user wouldn't have the feeling that the command should work straight away.

@josh146
Copy link
Member

josh146 commented Mar 31, 2020

It might be good to align with the approach taken in the PyQuil documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants