From ca9dca17a73ea6897d968574bc41333922cb4cb8 Mon Sep 17 00:00:00 2001 From: Jacob Feldman Date: Mon, 1 Jun 2026 10:46:54 -0700 Subject: [PATCH] deprecation: mark JAQCD action type and braket.ir.jaqcd module as deprecated (MCM-150287739) Amazon Braket service devices no longer accept JAQCD program submissions. This change adds Sphinx ``.. deprecated:: 1.29.3`` directives to: * DeviceActionType.JAQCD * JaqcdDeviceActionProperties * braket.ir.jaqcd module (__init__.py) * braket.ir.jaqcd.program_v1.Program * braket.ir.jaqcd.instructions module Customers should submit OpenQASM 3 programs (braket.ir.openqasm) instead. These symbols are intentionally retained so that historical task results and cached device-capability documents containing the ``braket.ir.jaqcd.program`` action type continue to deserialize. No symbol is removed and no runtime behavior changes. See MCM-150287739. --- src/braket/device_schema/device_action_properties.py | 6 ++++++ .../device_schema/jaqcd_device_action_properties.py | 6 ++++++ src/braket/ir/jaqcd/__init__.py | 11 +++++++++++ src/braket/ir/jaqcd/instructions.py | 10 ++++++++++ src/braket/ir/jaqcd/program_v1.py | 7 +++++++ 5 files changed, 40 insertions(+) diff --git a/src/braket/device_schema/device_action_properties.py b/src/braket/device_schema/device_action_properties.py index fa65c9da..8e9cc0a3 100644 --- a/src/braket/device_schema/device_action_properties.py +++ b/src/braket/device_schema/device_action_properties.py @@ -19,6 +19,12 @@ class DeviceActionType(str, Enum): """ These are the actions supported by Braket. + + .. deprecated:: 1.29.3 + ``JAQCD`` is deprecated. Amazon Braket service devices no longer accept + JAQCD program submissions; use ``OPENQASM`` (OpenQASM 3) instead. The + ``JAQCD`` enum member is retained so historical task results and cached + capability documents continue to deserialize. """ OPENQASM = "braket.ir.openqasm.program" diff --git a/src/braket/device_schema/jaqcd_device_action_properties.py b/src/braket/device_schema/jaqcd_device_action_properties.py index 7959cf5a..b2718af5 100644 --- a/src/braket/device_schema/jaqcd_device_action_properties.py +++ b/src/braket/device_schema/jaqcd_device_action_properties.py @@ -22,6 +22,12 @@ class JaqcdDeviceActionProperties(DeviceActionProperties): """ Defines the schema for properties for the actions that can be supported by JAQCD devices. + .. deprecated:: 1.29.3 + ``JaqcdDeviceActionProperties`` is deprecated. Amazon Braket service + devices no longer advertise the ``braket.ir.jaqcd.program`` action type; + use the OpenQASM action properties instead. This class is retained so + cached capability documents continue to deserialize. + Attributes: supportedOperations: Operations supported by the JAQCD action. supportedResultTypes: Result types that are supported by the JAQCD action. diff --git a/src/braket/ir/jaqcd/__init__.py b/src/braket/ir/jaqcd/__init__.py index 79d4a37d..b053c8f9 100644 --- a/src/braket/ir/jaqcd/__init__.py +++ b/src/braket/ir/jaqcd/__init__.py @@ -11,6 +11,17 @@ # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. +""" +JAQCD intermediate representation. + +.. deprecated:: 1.29.3 + The ``braket.ir.jaqcd`` module is deprecated. Amazon Braket service + devices no longer accept JAQCD program submissions; use the OpenQASM 3 + intermediate representation in :mod:`braket.ir.openqasm` instead. This + module is retained so historical task results that contain + ``braket.ir.jaqcd.program`` payloads continue to deserialize. +""" + from braket.ir.jaqcd.instructions import ( # noqa: F401 CV, CY, diff --git a/src/braket/ir/jaqcd/instructions.py b/src/braket/ir/jaqcd/instructions.py index 121cf645..4c7a50ea 100644 --- a/src/braket/ir/jaqcd/instructions.py +++ b/src/braket/ir/jaqcd/instructions.py @@ -11,6 +11,16 @@ # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. +""" +JAQCD instruction definitions. + +.. deprecated:: 1.29.3 + The instruction classes in this module are deprecated alongside the rest + of :mod:`braket.ir.jaqcd`. Amazon Braket service devices no longer accept + JAQCD program submissions; use OpenQASM 3 instead. These classes remain + importable so historical task results continue to deserialize. +""" + from enum import Enum from braket.ir.jaqcd.shared_models import ( diff --git a/src/braket/ir/jaqcd/program_v1.py b/src/braket/ir/jaqcd/program_v1.py index 3b6404ec..88dd2887 100644 --- a/src/braket/ir/jaqcd/program_v1.py +++ b/src/braket/ir/jaqcd/program_v1.py @@ -150,6 +150,13 @@ class Program(BraketSchemaBase): """ Root object of the JsonAwsQuantumCircuitDescription IR. + .. deprecated:: 1.29.3 + ``Program`` (the JAQCD program type) is deprecated. Amazon Braket + service devices no longer accept JAQCD program submissions; submit + an OpenQASM 3 program (:class:`braket.ir.openqasm.Program`) instead. + This class is retained so historical task results stored as + ``braket.ir.jaqcd.program`` payloads continue to deserialize. + Attributes: braketSchemaHeader (BraketSchemaHeader): Schema header. Users do not need to set this value. Only default is allowed.