azure-quantum 1.0.0.dev1__py3-none-any.whl → 1.1.0__py3-none-any.whl

azure/quantum/qiskit/provider.py

@@ -3,6 +3,12 @@
 # Licensed under the MIT License.
 ##
 
+import warnings
+import inspect
+from itertools import groupby
+from typing import Dict, List, Tuple, Type
+from azure.quantum import Workspace
+
 try:
     from qiskit.providers import ProviderV1 as Provider
     from qiskit.providers.exceptions import QiskitBackendNotFoundError
@@ -14,18 +20,10 @@ except ImportError:
 To install run: pip install azure-quantum[qiskit]"
     )
 
-
-from typing import Dict, List, Tuple, Type
-from azure.quantum import Workspace
 from azure.quantum.qiskit.backends.backend import AzureBackendBase
 from azure.quantum.qiskit.job import AzureQuantumJob
 from azure.quantum.qiskit.backends import *
-from itertools import groupby
-import warnings
-import inspect
 
-# Target ID keyword for parameter-free solvers
-PARAMETER_FREE = "parameterfree"
 
 QISKIT_USER_AGENT = "azure-quantum-qiskit"
 
@@ -39,7 +37,7 @@ class AzureQuantumProvider(Provider):
         """AzureQuantumService class
 
         :param workspace: Azure Quantum workspace. If missing it will create a new Workspace passing `kwargs` to the constructor. Defaults to None. 
-        :type workspace: Workspace, optional
+        :type workspace: Workspace
         """
         if kwargs is not None and len(kwargs) > 0:
             from warnings import warn
@@ -57,10 +55,13 @@ class AzureQuantumProvider(Provider):
         self._backends = None
 
     def get_workspace(self) -> Workspace:
+        """Return Azure Quantum Workspace"""
+
         return self._workspace
 
     def get_backend(self, name=None, **kwargs) -> AzureBackendBase:
         """Return a single backend matching the specified filtering.
+
         Args:
             name (str): name of the backend.
             **kwargs: dict used for filtering.
@@ -104,11 +105,12 @@ see https://aka.ms/AQ/Docs/AddProvider"
 
     def backends(self, name=None, **kwargs):
         """Return a list of backends matching the specified filtering.
+        
         Args:
             name (str): name of the backend.
             **kwargs: dict used for filtering.
         Returns:
-            list[Backend]: a list of Backends that match the filtering
+            typing.List[qiskit.providers.BackendV1]: a list of Backends that match the filtering
                 criteria.
         """
 
@@ -237,6 +239,7 @@ see https://aka.ms/AQ/Docs/AddProvider"
         or from a boolean callable. The criteria for filtering can
         be specified via `**kwargs` or as a callable via `filters`, and the
         backends must fulfill all specified conditions.
+        
         Args:
             backends (list[Backend]): list of backends.
             filters (callable): filtering conditions as a callable.

azure/quantum/target/__init__.py

@@ -2,11 +2,10 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 ##
+
+"""Defines set of targets for interacting with Azure Quantum"""
+
 from .target import Target
-from .solvers import Solver
-from .toshiba import (
-    SimulatedBifurcationMachine
-)
 from .ionq import IonQ
 from .quantinuum import Quantinuum
 from .rigetti import Rigetti
@@ -19,6 +18,13 @@ DEFAULT_TARGETS = {
     "ionq": IonQ,
     "quantinuum": Quantinuum,
     "rigetti": Rigetti,
-    "toshiba": Solver,
     "pasqal": Pasqal
 }
+
+
+__all__ = [
+    "Target",
+    "IonQ",
+    "Quantinuum",
+    "DEFAULT_TARGETS"
+    ]

azure/quantum/target/ionq.py

@@ -162,12 +162,12 @@ class IonQ(Target):
         :type num_shots: int
         :param price_1q: The price of running a single-qubit gate
             for one shot.
-        :type price_1q: float, optional
+        :type price_1q: float
         :param price_2q: The price of running a double-qubit gate
             for one shot.
-        :type price_2q: float, optional
+        :type price_2q: float
         :param min_price: The minimum price for running a job.
-        :type min_price: float, optional
+        :type min_price: float
         :param shots: Number of shots, defaults to None
         :type shots: int
         """

azure/quantum/target/microsoft/__init__.py

@@ -2,6 +2,9 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
+
+"""Defines classes for interacting with Microsoft Estimator"""
+
 __all__ = ["ErrorBudgetPartition", "MicrosoftEstimator",
            "MicrosoftEstimatorJob", "MicrosoftEstimatorResult",
            "MicrosoftEstimatorParams", "QECScheme", "QubitParams"]

azure/quantum/target/microsoft/elements/__init__.py

@@ -0,0 +1 @@
+"""Defines classes for interacting with Microsoft Elements services"""

azure/quantum/target/microsoft/elements/dft/__init__.py

@@ -1,3 +1,5 @@
+"""Defines classes for interacting with Microsoft Elements DFT service"""
+
 from .target import MicrosoftElementsDft
 from .job import MicrosoftElementsDftJob
 

azure/quantum/target/microsoft/elements/dft/job.py

@@ -10,10 +10,27 @@ class MicrosoftElementsDftJob(Job):
     """
 
     def __init__(self, workspace, job_details: JobDetails, **kwargs):
+        """Azure Quantum Job that is submitted to a given Workspace.
+
+        :param workspace: Workspace instance to submit job to
+        :type workspace: Workspace
+        :param job_details: Job details model,
+                contains Job ID, name and other details
+        :type job_details: JobDetails
+        """
         super().__init__(workspace, job_details, **kwargs)
 
 
     def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT) -> Dict[str, Any]:
+        """Get job results by downloading the results blob from the
+        storage container linked via the workspace.
+
+        :param timeout_secs: Timeout in seconds, defaults to 300
+        :type timeout_secs: float
+        :raises RuntimeError: Raises RuntimeError if job execution failed
+        :return: Results dictionary with histogram shots, or raw results if not a json object.
+        """
+
         try:
             job_results = super().get_results(timeout_secs)
             return job_results["results"]

azure/quantum/target/microsoft/elements/dft/target.py

@@ -25,6 +25,13 @@ class MicrosoftElementsDft(Target):
         name: str = "microsoft.dft",
         **kwargs
     ):
+        """
+        Initializes a new DFT target.
+
+        :param workspace: Associated workspace
+        :type workspace: Workspace
+        :param name: Target name
+        """
         # There is only a single target name for this target
         assert name == self.target_names[0]
 
@@ -48,6 +55,20 @@ class MicrosoftElementsDft(Target):
                shots: int = None,
                input_params: Union[Dict[str, Any], InputParams, None] = None,
                **kwargs) -> MicrosoftElementsDftJob:
+        """
+        Submit DFT job to Azure Quantum Services.
+        
+        :param input_data: Input data
+        :type input_data: Any
+        :param name: Job name
+        :type name: str
+        :param shots: Number of shots. Ignored in DFT job. Defaults to None
+        :type shots: int
+        :param input_params: Input parameters
+        :type input_params: Dict[str, Any]
+        :return: Azure Quantum job
+        :rtype: Job
+        """
 
         if shots is not None:
             warnings.warn("The 'shots' parameter is ignored in Microsoft Elements Dft job.")

azure/quantum/target/microsoft/job.py

@@ -16,6 +16,14 @@ class MicrosoftEstimatorJob(Job):
         super().__init__(workspace, job_details, **kwargs)
 
     def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT) -> MicrosoftEstimatorResult:
+        """
+        Get estimation result.
+
+        :param timeout_secs: Timeout in seconds, defaults to 300 sec.
+        :type timeout_secs: float
+        :return: Estimation result
+        :rtype: MicrosoftEstimatorResult
+        """
         try:
             results = super().get_results(timeout_secs)
             return MicrosoftEstimatorResult(results)

azure/quantum/target/microsoft/target.py

@@ -16,6 +16,10 @@ from ..target import Target
 from . import MicrosoftEstimatorJob
 
 class QubitParams:
+    """
+    Resource estimator Qubit parameters.
+    """
+
     GATE_US_E3 = "qubit_gate_us_e3"
     GATE_US_E4 = "qubit_gate_us_e4"
     GATE_NS_E3 = "qubit_gate_ns_e3"
@@ -25,6 +29,10 @@ class QubitParams:
 
 
 class QECScheme:
+    """
+    Resource estimator QEC Scheme.
+    """
+
     SURFACE_CODE = "surface_code"
     FLOQUET_CODE = "floquet_code"
 
@@ -243,6 +251,9 @@ class DistillationUnitSpecification(AutoValidatingParams):
 
 @dataclass
 class ErrorBudgetPartition(AutoValidatingParams):
+    """
+    Resource estimator error budget partition parameters.
+    """
     logical: float = 0.001 / 3
     t_states: float = 0.001 / 3
     rotations: float = 0.001 / 3
@@ -250,6 +261,10 @@ class ErrorBudgetPartition(AutoValidatingParams):
 
 @dataclass
 class MicrosoftEstimatorConstraints(AutoValidatingParams):
+    """
+    Resource estimator constraints.
+    """
+
     @staticmethod
     def at_least_one(name, value):
         if value < 1:
@@ -339,6 +354,9 @@ class MicrosoftEstimatorInputParamsItem(InputParamsItem):
 
 
 class MicrosoftEstimatorParams(InputParams, MicrosoftEstimatorInputParamsItem):
+    """
+    Resource estimator input parameters.
+    """
     def __init__(self, num_items: Optional[int] = None):
         InputParams.__init__(
             self,
@@ -386,7 +404,7 @@ class MicrosoftEstimator(Target):
         **kwargs,
     ) -> Job:
         """
-        Submit an estimation job
+        Submit an estimation job.
 
         :param input_data: Input data
         :type input_data: Any

azure/quantum/target/params.py

@@ -8,6 +8,9 @@ from typing import Any, Dict, List, Optional, Tuple, Type, Callable
 from ..argument_types import EmptyArray, Pauli, Range, Result
 
 
+__all__ = ["InputParams"]
+
+
 class EntryPointArguments:
     """
     Wrapper class to set QIR entry point arguments.

azure/quantum/target/pasqal/result.py

@@ -18,17 +18,23 @@ from ...job import Job
 class Result:
     """Downloads the data of a completed Job and provides a dictionary of registers.
 
-    >>> from azure.quantum.job import Job
-    >>> from azure.quantum.target.pasqal import Result
-    >>> job = Job(...)  # This job should come from a Pasqal target
-    >>> job.wait_until_completed()
-    >>> result = Result(job)
+    .. highlight:: python
+    .. code-block::
+
+       from azure.quantum.job import Job
+       from azure.quantum.target.pasqal import Result
+       job = Job(...)  # This job should come from a Pasqal target
+       job.wait_until_completed()
+       result = Result(job)
+
     """
 
     def __init__(self, job: Job) -> None:
         """
         Decode the results of a Job with output type of "pasqal.pulser-results.v1"
 
+        :param job: Azure Quantum job
+        :type job: Job
         :raises: RuntimeError if the job has not completed successfully
         """
 

azure/quantum/target/pasqal/target.py

@@ -52,6 +52,8 @@ class PasqalTarget(str, Enum):
 
 @dataclass
 class InputParams:
+    """Input parameters"""
+
     runs: int = 1
     """The number of times to run the experiment."""
 

azure/quantum/target/quantinuum.py

@@ -121,18 +121,18 @@ class Quantinuum(Target):
         :param circuit: Quantum circuit in OpenQASM 2.0 format
         :type circuit: str
         :param num_shots: Number of shots for which to estimate costs
-        :type num_shots: int, optional
+        :type num_shots: int
         :param N_1q: Number of one-qubit gates, if not specified,
             this is estimated from the circuit
-        :type N_1q: int, optional
+        :type N_1q: int
         :param N_2q: Number of two-qubit gates, if not specified,
             this is estimated from the circuit
-        :type N_2q: int, optional
+        :type N_2q: int
         :param N_m: Number of measurement operations, if not specified,
             this is estimated from the circuit
-        :type N_m: int, optional
+        :type N_m: int
         :param shots: Number of shots for which to estimate costs
-        :type shots: int, optional
+        :type shots: int
         :raises ImportError: If N_1q, N_2q and N_m are not specified,
             this will require a qiskit installation.
         """
@@ -149,8 +149,8 @@ class Quantinuum(Target):
 
         if circuit is not None and (N_1q is None or N_2q is None or N_m is None):
             try:
-                from qiskit.circuit.quantumcircuit import Qasm
-                from qiskit.converters import ast_to_dag
+                from qiskit.qasm2 import loads
+                from qiskit.converters.circuit_to_dag import circuit_to_dag
 
             except ImportError:
                 raise ImportError(
@@ -160,9 +160,8 @@ class Quantinuum(Target):
 
             else:
                 from qiskit.dagcircuit.dagnode import DAGOpNode
-                qasm = Qasm(data=circuit)
-                ast = qasm.parse()
-                dag = ast_to_dag(ast)
+                circuit_obj = loads(string=circuit)
+                dag = circuit_to_dag(circuit=circuit_obj)
                 N_1q, N_2q, N_m = 0, 0, 0
                 for node in dag._multi_graph.nodes():
                     if isinstance(node, DAGOpNode):

azure/quantum/target/rigetti/result.py

@@ -34,6 +34,8 @@ class Result:
         """
         Decode the results of a Job with output type of "rigetti.quil-results.v1"
 
+        :param job: Azure Quantum Job
+        :type job: Job
         :raises: RuntimeError if the job has not completed successfully
         """
 

azure/quantum/target/rigetti/target.py

@@ -30,7 +30,6 @@ class RigettiTarget(str, Enum):
     """A simulator target for Quil. See https://github.com/quil-lang/qvm for more info."""
 
     ANKAA_9Q_1 = "rigetti.qpu.ankaa-9q-1"
-    ASPEN_M_3 = "rigetti.qpu.aspen-m-3"
     ANKAA_2 = "rigetti.qpu.ankaa-2"
 
     def simulators() -> List[str]:
@@ -43,7 +42,6 @@ class RigettiTarget(str, Enum):
         """Returns a list of QPU targets"""
         return [
             RigettiTarget.ANKAA_9Q_1.value,
-            RigettiTarget.ASPEN_M_3.value,
             RigettiTarget.ANKAA_2.value,
         ]
 
@@ -54,8 +52,6 @@ class RigettiTarget(str, Enum):
             return 9
         elif target_name == RigettiTarget.QVM.value:
             return 20
-        elif target_name == RigettiTarget.ASPEN_M_3.value:
-            return 80
         elif target_name == RigettiTarget.ANKAA_2.value:
             return 84
         else:
@@ -71,9 +67,12 @@ class InputParams:
     """
 
     skip_quilc: bool = False
-    """If set to True, `quilc <https://github.com/quil-lang/quilc>`_ will not be run.
+    """
+    If set to True, `quilc`_ will not be run.
     
     This **must** be set true if using `Quil-T <https://pyquil-docs.rigetti.com/en/stable/quilt.html>`_.
+    
+    .. _quilc: https://github.com/quil-lang/quilc
     """
 
     substitutions: Optional[Dict[str, List[List[float]]]] = None

azure/quantum/target/target.py

@@ -42,6 +42,7 @@ class Target(abc.ABC, SessionHost):
     # __init__ via the job_cls parameter.  This is then used by the target's
     # submit and get_job method.
     target_names = ()
+    """Tuple of target names."""
 
     # Name of the provider's input parameter which specifies number of shots for a submitted job.
     # If None, target will not pass this input parameter. 
@@ -62,6 +63,27 @@ class Target(abc.ABC, SessionHost):
     ):
         """
         Initializes a new target.
+
+        :param workspace: Associated workspace
+        :type workspace: Workspace
+        :param name: Target name
+        :type name: str
+        :param input_data_format: Format of input data (ex. "qir.v1")
+        :type input_data_format: str
+        :param output_data_format: Format of output data (ex. "microsoft.resource-estimates.v1")
+        :type output_data_format: str
+        :param capability: QIR capability
+        :type capability: str
+        :param provider_id: Id of provider (ex. "microsoft-qc")
+        :type provider_id: str
+        :param content_type: "Content-Type" attribute value to set on input blob (ex. "application/json")
+        :type content_type: ContentType
+        :param encoding: "Content-Encoding" attribute value to set on input blob (ex. "gzip")
+        :type encoding: str
+        :param average_queue_time: Set average queue time (for internal use)
+        :type average_queue_time: float
+        :param current_availability: Set current availability (for internal use)
+        :type current_availability: str
         """
         if not provider_id and "." in name:
             provider_id = name.split(".")[0]
@@ -132,10 +154,18 @@ target '{self.name}' of provider '{self.provider_id}' not found."
 
     @property
     def current_availability(self):
+        """
+        Current availability.
+        """
+
         return self._current_availability
 
     @property
     def average_queue_time(self):
+        """
+        Average queue time.
+        """
+        
         return self._average_queue_time
 
     @staticmethod
@@ -183,7 +213,7 @@ target '{self.name}' of provider '{self.provider_id}' not found."
         :param input_params: Input parameters
         :type input_params: Dict[str, Any]
         :return: Azure Quantum job
-        :rtype: Job
+        :rtype: azure.quantum.job.Job
         """
 
         if isinstance(input_params, InputParams):
@@ -240,13 +270,15 @@ target '{self.name}' of provider '{self.provider_id}' not found."
             # The 'shots' parameter has highest priority.
             elif shots is not None:
                 final_shots = shots
-            # if nothing, try a provider-specific option.
-            else:
+            # if 'shots' parameter is not specified, try a provider-specific option.
+            elif input_params_shots is not None:
                 warnings.warn(
                     f"Field '{self.__class__._SHOTS_PARAM_NAME}' from the 'input_params' parameter is subject to change in future versions. "
                     "Please, use 'shots' parameter instead."
                 )
                 final_shots = input_params_shots
+            else:
+                final_shots = None
             
             if final_shots is not None:
                 input_params[self.__class__._SHOTS_PARAM_NAME] = final_shots
@@ -281,6 +313,9 @@ target '{self.name}' of provider '{self.provider_id}' not found."
         input_data: Any,
         input_params: Union[Dict[str, Any], None] = None
     ):
+        """
+        Estimate the cost for a given circuit.
+        """
         return NotImplementedError("Price estimation is not implemented yet for this target.")
 
     def _get_azure_workspace(self) -> "Workspace":

azure/quantum/target/target_factory.py

@@ -10,9 +10,6 @@ if TYPE_CHECKING:
     from azure.quantum import Workspace
     from azure.quantum._client.models import TargetStatus
 
-# Target ID keyword for parameter-free solvers
-PARAMETER_FREE = "parameterfree"
-
 
 class TargetFactory:
     """Factory class for generating a Target based on a
@@ -136,13 +133,10 @@ https://github.com/microsoft/qdk-python/issues.")
             return self.from_target_status(*target_statuses[0], **kwargs)
 
         else:
-            # Don't return redundant parameter-free targets
+            # Don't return redundant targets
             return [
                 self.from_target_status(_provider_id, status, **kwargs)
                 for _provider_id, status in target_statuses
-                if PARAMETER_FREE not in status.id
-                and (
-                    _provider_id.lower() in self._default_targets
+                if _provider_id.lower() in self._default_targets
                     or status.id in self._all_targets
-                )
             ]

azure/quantum/version.py

@@ -5,4 +5,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
-__version__ = "1.0.0.dev1"
+__version__ = "1.1.0"