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

Add sessions how-to and update links #1297

Merged
merged 16 commits into from
Nov 8, 2023

Conversation

coruscating
Copy link
Collaborator

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.

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

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.

@coruscating coruscating added the documentation Improvements or additions to documentation label Oct 30, 2023
Copy link
Collaborator

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

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.

docs/_ext/custom_styles/formatter.py Outdated Show resolved Hide resolved
docs/howtos/runtime_sessions.rst Show resolved Hide resolved
docs/howtos/runtime_sessions.rst Outdated Show resolved Hide resolved
docs/howtos/runtime_sessions.rst Outdated Show resolved Hide resolved
docs/howtos/runtime_sessions.rst Show resolved Hide resolved
Copy link
Collaborator

@wshanks wshanks left a 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.

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

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?

Copy link
Collaborator Author

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.

@coruscating coruscating added this pull request to the merge queue Nov 8, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 8, 2023
@coruscating coruscating added this pull request to the merge queue Nov 8, 2023
Merged via the queue into qiskit-community:main with commit 8bda25d Nov 8, 2023
11 checks passed
@coruscating coruscating deleted the update-docs branch November 8, 2023 22:06
nkanazawa1989 pushed a commit to nkanazawa1989/qiskit-experiments that referenced this pull request Jan 17, 2024
### 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants