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

Migration guide for providers to implement V2 primitives #2496

Open
wants to merge 42 commits into
base: main
Choose a base branch
from

Conversation

ElePT
Copy link
Collaborator

@ElePT ElePT commented Dec 17, 2024

This is a proposal for content to address #2469. After a brief discussion with @jyu00 we agreed that we should focus this migration guide on showing how to implement new primitives for providers. However, I have not been involved in all discussions regarding the vision for this migration (and conversations around backend.run tend to raise a lot of different opinions) so I would appreciate confirmation that the content proposed fits the direction we want to show.

The page is currently in a pretty raw state, missing formatting, API ref links, a review on the titles, capitalization, etc, but I wanted to open a PR as fast as possible to ask for opinions on including the backend primitive wrappers as a tool for provider migration. This idea came from inspecting the only instance I know of external provider beyond the immediate product sphere, which is https://github.com/qiskit-community/qiskit-aqt-provider/tree/master, and subclasses backend primitives to expose their own primitive implementations. Following this, I decided to structure the page as follows:

  • motivation: @jyu00 mentioned this was often requested by users, I tried to keep it short and touch on the usefulness of the abstraction level of the primitives
  • Backend primitives as a migration alternative for providers that already implemented backend.run (following the AQT example)
  • Custom primitives as an alternative for providers that want it, or didn't implement backend.run (following the StatevectorSampler and StatevectorEstimator) examples

Please let me know if you have any other take on how the content should look like @javabster, @jyu00.

Copy link
Collaborator

@abbycross abbycross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last question to resolve and then I think it's ready to go

Copy link
Collaborator

@jyu00 jyu00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions for consistency, but otherwise looks good!


The following migration guides can help users with the following tasks:

- [Transition to the Qiskit Runtime provider](/migration-guides/qiskit-runtime)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok... but why is it called Transition to the Qiskit Runtime provider? Is it meant to say transitioning from qiskit-ibmq-provider / qiskit-ibm-provider to qiskit-ibm-runtime ?

Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
@jyu00
Copy link
Collaborator

jyu00 commented Mar 12, 2025

@abbycross how come some of the links were added to open new tabs but the rest are not? Is there a standard on what should / should not open a new tab?

image

@abbycross
Copy link
Collaborator

@abbycross how come some of the links were added to open new tabs but the rest are not? Is there a standard on what should / should not open a new tab?

All external links. (i.e., not coming from an IBM repo) will open in a new tab. Therefore, the ones from https://qiskit.github.io/ will all have that external-link arrow. I see that the last link in your screenshot should have been an internal link - I missed that in my review! Fixed it.
Note that links to the UI (like to the compute resources, page, the dashboard, etc.) should be linked to with the whole URL and will render as an external link.

Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Elena!

@abbycross
Copy link
Collaborator

Has this comment been resolved? This PR has gotten too noisy to be absolutely sure :-)

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

Successfully merging this pull request may close these issues.

7 participants