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

New "Create a provider" page #2012

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/open-source/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@
"title": "Version strategy",
"url": "/open-source/qiskit-sdk-version-strategy"
},
{
"title": "Create a provider",
"url": "/open-source/create-a-provider"
},
{
"title": "Contributor guide",
"url": "https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md"
Expand Down
20 changes: 20 additions & 0 deletions docs/open-source/create-a-provider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Create a provider
description: A short guide on integrating Qiskit into an external provider's quantum resources.
---
# Integrate external quantum resources with Qiskit

The Qiskit SDK is built to support third parties in creating external providers of quantum resources.

This means that any organization which develops or deploys quantum compute resources can integrate their services into Qiskit and tap into its userbase.

Doing so requires creating a package which supports requests for quantum compute resources and returns them to the user.

Additionally, the package must allow users to submit jobs and retrieve their results through an implementation of the `qiskit.primitives` objects.

## Providing access to backends
In order for users to transpile and execute `QuantumCircuit` objects using external resources, they need to instantiate an object containing a [`Target`](../api/qiskit/qiskit.transpiler.Target) which provides information about a QPU's constraints such as its connectivity, basis gates, and number of qubits. This can be provided through an interface similar to the [`QiskitRuntimeService`](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) through which a user can make requests for a QPU. This object should, at minimum, contain a `Target`, but a simpler approach would be to return a [`BackendV2`](../api/qiskit/qiskit.providers.BackendV2) instance.

## Providing an interface for execution
In addition to providing a service returning hardware configurations, a service providing access to external QPU resources also might also support the execution of quantum workloads. Exposing that capability can be done by creating implementations of the Qiskit primitives interfaces; for example the (../api/qiskit/qiskit.primitives.BasePrimitiveJob), [`BaseEstimatorV2`](../api/qiskit/qiskit.primitives.BaseEstimatorV2) and [`BaseSamplerV2`](../api/qiskit/qiskit.primitives.BaseSamplerV2) among others. At minimum, these interfaces should be able to provide a method for execution, querying job status, and returning the job results.
See the `qiskit.primitives` [API documentation](../api/qiskit/primitives) for more information.
Loading