-
Notifications
You must be signed in to change notification settings - Fork 127
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
Add sessions how-to and update links #1297
Conversation
@@ -104,21 +104,17 @@ https://stestr.readthedocs.io/en/stable/MANUAL.html#test-selection | |||
If you want to run a single test module, test class, or individual test method you can | |||
do this faster with the `-n`/`--no-discover` option. For example, to run a module: | |||
``` | |||
tox -- -n test.python.test_examples |
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.
These commands were not working since some environments such as lint did not recognize the option, so an environment has to be specified.
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.
This looks good.
Do we care about backporting the fixes for the broken links before the next minor release so the current live documentation has working links? Even though this has an addition rather than just a fix it is probably fine to backport but we were considering waiting for a qiskit-ibm-provider release.
|
||
``` | ||
tox -- -n test/python/test_examples.py |
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.
I wish this worked 🙂 It would make tab completion easier. I try it sometimes because it's what pytest uses and I forget it's not what unittest uses.
Co-authored-by: Will Shanks <[email protected]>
Co-authored-by: Will Shanks <[email protected]>
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.
Just one more question.
docs/howtos/runtime_sessions.rst
Outdated
session.cancel() | ||
|
||
Note that runtime primitives are not currently supported natively in Qiskit Experiments, so either | ||
the `backend.run()` path or the ``circuit-runner`` program in ``qiskit-ibm-runtime`` is required |
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.
Should we still mention circuit-runner
? It takes quite a bit of set up to use with experiments (the section you removed) so I am not sure it helps to mention it without explaining how. By the way, do you know what will happen when qiskit-ibm-provider merges into qiskit-ibm-runtime? Will we just need to update this to import from qiskit_ibm_runtime
and get a backend from it?
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.
Good point, circuit-runner
isn't mentioned in the current runtime docs either, so I've removed it. Yes, based on Qiskit/qiskit-ibm-runtime#1138, I think you'd just get the backend object via service.backend()
in the runtime provider and everything else should stay the same.
### Summary This PR adds a sessions how-to based on the discussions in qiskit-community#1226. It also updates some outdated documentation, such as the links to the Qiskit Textbook which were all broken. --------- Co-authored-by: Will Shanks <[email protected]>
Summary
This PR adds a sessions how-to based on the discussions in #1226. It also updates some outdated documentation, such as the links to the Qiskit Textbook which were all broken.