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

Add deprecation warning for abstract circuits #1404

Merged
merged 5 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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 qiskit_ibm_runtime/base_primitive.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
from .runtime_job import RuntimeJob
from .ibm_backend import IBMBackend
from .utils.default_session import get_cm_session
from .utils.utils import validate_isa_circuits
from .constants import DEFAULT_DECODERS
from .qiskit_runtime_service import QiskitRuntimeService

Expand Down Expand Up @@ -137,6 +138,9 @@ def _run_primitive(self, primitive_inputs: Dict, user_kwargs: Dict) -> RuntimeJo
Returns:
Submitted job.
"""
if self._backend and hasattr(self._backend, "target"):
validate_isa_circuits(primitive_inputs["circuits"], self._backend.target)

combined = Options._merge_options(self._options, user_kwargs)

if self._backend:
Expand Down
44 changes: 43 additions & 1 deletion qiskit_ibm_runtime/utils/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,61 @@
import os
import re
import hashlib
import warnings
from queue import Queue
from threading import Condition
from typing import List, Optional, Any, Dict, Union, Tuple
from typing import List, Optional, Any, Dict, Union, Tuple, Sequence
from urllib.parse import urlparse

import requests
from ibm_cloud_sdk_core.authenticators import ( # pylint: disable=import-error
IAMAuthenticator,
)
from ibm_platform_services import ResourceControllerV2 # pylint: disable=import-error
from qiskit.circuit import QuantumCircuit
from qiskit.transpiler import Target
from qiskit_ibm_runtime.exceptions import IBMInputValueError


def is_isa_circuit(circuit: QuantumCircuit, target: Target) -> bool:
"""Checks if the circuit is an ISA circuit, meaning that it has a layout and that it
only uses instructions that exist in the target.
Args:
circuit: A single QuantumCircuit
target: A Qiskit Target
Returns:
Boolean True if the circuit is an ISA circuit
"""
if circuit.layout is None:
return False
for instruction in circuit.data:
name = instruction.operation.name
qargs = tuple(circuit.find_bit(x).index for x in instruction.qubits)
if not target.instruction_supported(name, qargs) and name != "barrier":
return False
return True


def validate_isa_circuits(circuits: Sequence[QuantumCircuit], target: Target) -> None:
"""Validate if all circuits are ISA circuits
Args:
circuits: A list of QuantumCircuits
target: A Qiskit Target
Raises:
NonISACircuitsError if some of the circuits are not ISA circuits
"""
if not all(is_isa_circuit(circuit, target) for circuit in circuits):
warnings.warn(
"Circuits that do not match the target hardware definition will no longer be supported "
"after March 1, 2024. See the transpilation documentation "
"(https://docs.quantum.ibm.com/transpile) for instructions to transform circuits and "
"the primitive examples (https://docs.quantum.ibm.com/run/primitives-examples) to see "
"this coupled with operator transformations.",
DeprecationWarning,
stacklevel=6,
)


def validate_job_tags(job_tags: Optional[List[str]]) -> None:
"""Validates input job tags.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
deprecations:
- |
Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024.
See the transpilation documentation (https://docs.quantum.ibm.com/transpile) for instructions to
transform circuits and the primitive examples (https://docs.quantum.ibm.com/run/primitives-examples)
to see this coupled with operator transformations.
Loading