Remove deprecated provider mentions from docs (#1438)

Replace mentions of the provider in the docs with the runtime provider and remove its intersphinx link.
qiskit-community · Apr 18, 2024 · 3b039c5 · 3b039c5
1 parent 44178f7
commit 3b039c5
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 15 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -167,7 +167,6 @@
     "qiskit_aer": ("https://qiskit.github.io/qiskit-aer/", None),
     "qiskit_dynamics": ("https://qiskit-extensions.github.io/qiskit-dynamics/", None),
     "qiskit_ibm_runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None),
-    "qiskit_ibm_provider": ("https://docs.quantum.ibm.com/api/qiskit-ibm-provider/", None),
 }
 
 

diff --git a/docs/howtos/cloud_service.rst b/docs/howtos/cloud_service.rst
@@ -19,7 +19,7 @@ Saving
 
 .. note::
     This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
+    For how to migrate from the older ``qiskit-ibm-provider`` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
 You must run the experiment on a real IBM

diff --git a/docs/howtos/rerun_analysis.rst b/docs/howtos/rerun_analysis.rst
@@ -13,7 +13,7 @@ Solution
 
 .. note::
     This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
+    For how to migrate from the older ``qiskit-ibm-provider`` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
 Once you recreate the exact experiment you ran and all of its parameters and options,
@@ -25,18 +25,18 @@ job IDs:
 .. jupyter-input::
 
     from qiskit_experiments.framework import ExperimentData
-    from qiskit_ibm_provider import IBMProvider
+    from qiskit_ibm_runtime import QiskitRuntimeService
 
     # The experiment you ran
     experiment = Experiment(**opts)
 
     # List of job IDs for the experiment
-    job_ids= [job1, job2, ...]
+    job_ids= ["job1_id", "job2_id", ...]
 
-    provider = IBMProvider()
+    service = QiskitRuntimeService(channel="ibm_quantum")
 
     expdata = ExperimentData(experiment = experiment)
-    expdata.add_jobs([provider.retrieve_job(job_id) for job_id in job_ids])
+    expdata.add_jobs([service.job(job_id) for job_id in job_ids])
     experiment.analysis.run(expdata, replace_results=True)
 
     # Block execution of subsequent code until analysis is complete
@@ -51,7 +51,7 @@ invoke the :meth:`.ExperimentData.add_data` method instead of :meth:`.Experiment
 
 .. jupyter-input::
 
-    data.add_data([provider.retrieve_job(job_id).result() for job_id in job_ids])
+    data.add_data([service.job(job_id).result() for job_id in job_ids])
 
 The remaining workflow remains the same.
 
@@ -116,7 +116,7 @@ first component experiment.
     )
 
     data = ExperimentData(experiment=pexp)
-    data.add_jobs([provider.retrieve_job(job_id) for job_id in job_ids])
+    data.add_jobs([service.job(job_id) for job_id in job_ids])
     pexp.analysis.run(data, replace_results=True)
 
 See Also

diff --git a/docs/howtos/runtime_sessions.rst b/docs/howtos/runtime_sessions.rst
@@ -12,7 +12,7 @@ Solution
 
 .. note::
     This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``.
-    For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
+    For how to migrate from the older ``qiskit-ibm-provider`` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`,
     consult the `migration guide <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.\
 
 Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :external+qiskit_ibm_runtime:doc:`index`, which supports sessions.

diff --git a/docs/manuals/measurement/restless_measurements.rst b/docs/manuals/measurement/restless_measurements.rst
@@ -189,7 +189,7 @@ using the code below.
     tau = sum(durations) * dt / (len(durations))
 
     n_circs = len(cal_drag.circuits())
-    # can be obtained from backend.default_rep_delay on a backend from qiskit-ibm-provider
+    # can be obtained from backend.default_rep_delay on a backend from qiskit-ibm-runtime
 
     delay_s = 0.0025
     delay_r = 1e-6  # restless delay

diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst
@@ -306,7 +306,7 @@ supports can be set:
 
 Consult the documentation of the run method of your
 specific backend type for valid options.
-For example, see :meth:`qiskit_ibm_provider.IBMBackend.run` for IBM backends.
+For example, see :meth:`qiskit_ibm_runtime.IBMBackend.run` for IBM backends.
 
 Transpile options
 -----------------

diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml
@@ -10,7 +10,7 @@ prelude: >
     :class:`.StarkRamseyXYAmpScan`. :class:`.StandardRB` and :class:`.InterleavedRB` were
     significantly improved. The supported provider for running jobs on IBM backends is now
     :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>`. Using 
-    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` is still supported
+    ``qiskit-ibm-provider`` is still supported
     but its use is deprecated.
 features:
   - |

diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml
@@ -5,8 +5,8 @@ features_expdata:
     to and loaded from the cloud service.
 upgrade_package:
   - |
-    With the impending deprecation of the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` package, support for
-    :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider <index>` is now deprecated and will be removed
+    With the impending deprecation of the ``qiskit-ibm-provider`` package, support for
+    ``qiskit-ibm-provider`` is now deprecated and will be removed
     in the next release. Users should migrate to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime <index>` following the
     `runtime migration guide
     <https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime-from-provider>`_.