Skip to content

Commit

Permalink
Deprecate channel strategy (#1931)
Browse files Browse the repository at this point in the history
* Deprecate channel strategy

* add release note

* formatting

* formatting

* Updating wording
  • Loading branch information
kt474 authored Sep 19, 2024
1 parent f2108d1 commit ceda69d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 2 deletions.
32 changes: 30 additions & 2 deletions qiskit_ibm_runtime/qiskit_runtime_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def __init__(
``username_ntlm``, ``password_ntlm`` (username and password to enable NTLM user
authentication)
verify: Whether to verify the server's TLS certificate.
channel_strategy: Error mitigation strategy.
channel_strategy: (DEPRECATED) Error mitigation strategy.
private_endpoint: Connect to private API URL.
url_resolver: Function used to resolve the runtime url.
Expand All @@ -128,6 +128,20 @@ def __init__(
"""
super().__init__()

if channel_strategy:
warnings.warn(
(
"As of qiskit-ibm-runtime version 0.30.0, the channel_strategy parameter is "
"deprecated. Q-CTRL Performance Management strategy currently offered "
"on the Qiskit Runtime Service will be removed on 18 October, 2024. "
"To continue using Q-CTRL in your workflow, use one of the following options: "
"Qiskit Functions Catalog: https://quantum.ibm.com/functions, or "
"Fire Opal: https://q-ctrl.com/fire-opal"
),
DeprecationWarning,
stacklevel=2,
)

self._account = self._discover_account(
token=token,
url=url,
Expand Down Expand Up @@ -698,12 +712,26 @@ def save_account(
authentication)
verify: Verify the server's TLS certificate.
overwrite: ``True`` if the existing account is to be overwritten.
channel_strategy: Error mitigation strategy.
channel_strategy: (DEPRECATED) Error mitigation strategy.
set_as_default: If ``True``, the account is saved in filename,
as the default account.
private_endpoint: Connect to private API URL.
"""

if channel_strategy:
warnings.warn(
(
"As of qiskit-ibm-runtime version 0.30.0, the channel_strategy parameter is "
"deprecated. Q-CTRL Performance Management strategy currently offered "
"on the Qiskit Runtime Service will be removed on 18 October, 2024."
"To continue using Q-CTRL in your workflow, use one of the following options: "
"Qiskit Functions Catalog: https://quantum.ibm.com/functions, or "
"Fire Opal: https://q-ctrl.com/fire-opal"
),
DeprecationWarning,
stacklevel=2,
)

AccountManager.save(
token=token,
url=url,
Expand Down
12 changes: 12 additions & 0 deletions release-notes/unreleased/1931.deprecation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The ``channel_strategy`` parameter has been deprecated.
The Q-CTRL Performance Management strategy will be removed on October 18th, 2024.
To continue using Q-CTRL in your workflow, please explore the following options:

- If your organization has an existing IBM Quantum Premium Plan instance: migrate to
the Q-CTRL Performance Management Function, found in the
`Qiskit Functions Catalog <https://quantum.ibm.com/functions>`__.

- To continue using Qiskit Runtime with IBM Cloud: migrate to Q-CTRL Fire Opal,
the same performance management product accessible directly through Q-CTRL.
You can `connect your IBM Cloud API key and Qiskit Runtime CRN <https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials>`__
to Fire Opal.

0 comments on commit ceda69d

Please sign in to comment.