(fix): deprecate class qiskit_ibm_runtime.IBMSampler for the next release

qiskit_ibm_runtime/__init__.py

@@ -228,7 +228,6 @@ def result_callback(job_id, result):
    RuntimeDecoder
    IBMRuntimeService
    IBMEstimator
-   IBMSampler
 """
 
 import logging
@@ -245,7 +244,6 @@ def result_callback(job_id, result):
 from .version import __version__
 
 from .ibm_estimator import IBMEstimator
-from .ibm_sampler import IBMSampler
 from .estimator import Estimator
 from .sampler import Sampler
 

qiskit_ibm_runtime/sampler.py

@@ -23,9 +23,8 @@
 from .qiskit_runtime_service import QiskitRuntimeService
 from .runtime_session import RuntimeSession
 
-
 class Sampler(BaseSampler):
-    """Class for interacting with Qiskit Runtime Sampler primitive service.
+    """Class for interacting with Qiskit Runtime Sampler primitive service. Additionally, the successor of deprecated ``IBMSampler`` class.
 
     Qiskit Runtime Sampler primitive service calculates probabilities or quasi-probabilities
     of bitstrings from quantum circuits.

releasenotes/notes/0.4/deprecate-classes-ef077e50db9718bc.yaml

@@ -82,4 +82,4 @@ deprecations:
     and :class:`~qiskit_ibm_runtime.IBMSampler` classes have been deprecated and will be removed
     in a future release. Use :class:`~qiskit_ibm_runtime.QiskitRuntimeService`,
     :class:`~qiskit_ibm_runtime.Estimator` and :class:`~qiskit_ibm_runtime.Sampler` classes
-    instead. See upgrade notes section for a detailed explanation with examples.
+    instead. See upgrade notes section for a detailed explanation with examples.

releasenotes/notes/remove-ibm-sampler-7779165095fd2a5f.yaml

@@ -0,0 +1,35 @@
+---
+upgrade:
+  - |
+    :class:`~qiskit_ibm_runtime.IBMSampler` class is now deprecated and removed
+    with this `remove-ibm-sampler` release. Use
+    :class:`~qiskit_ibm_runtime.Sampler` class going forward.
+
+    Example:
+
+    Before::
+
+      from qiskit_ibm_runtime import IBMRuntimeService, IBMSampler
+      service = IBMRuntimeService(channel="ibm_cloud", token="...", instance="...")
+
+      sampler_factory = IBMSampler(service=service, backend="ibmq_qasm_simulator")
+
+      with sampler_factory(circuits=[qc], parameters="...") as sampler:
+          result = sampler(circuit_indices=[0], ...)
+
+    After::
+
+      from qiskit_ibm_runtime import QiskitRuntimeService, Sampler
+      service = QiskitRuntimeService(channel="ibm_cloud", token="...", instance="...")
+
+      with Sampler(
+        circuits=[qc],
+        parameters="...",
+        service=service,
+        options={ "backend": "ibmq_qasm_simulator" },  # or IBMBackend<"ibmq_qasm_simulator">
+      ) as sampler:
+          result = sampler(circuit_indices=[0], ...)
+deprecations:
+  - |
+    Deprecated :class:`~qiskit_ibm_runtime.IBMSampler` class has been removed with its dependencies.
+    Use :class:`~qiskit_ibm_runtime.Sampler` class instead. See upgrade notes section for a detailed explanation with examples.