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

azure/quantum/__init__.py

@@ -3,6 +3,9 @@
 # Licensed under the MIT License.
 ##
 
+"""Defines interfaces for interacting with Azure Quantum"""
+
+
 import logging
 from .version import __version__
 
@@ -14,3 +17,6 @@ from ._client.models._enums import JobStatus, SessionStatus, SessionJobFailurePo
 
 logger = logging.getLogger(__name__)
 logger.info(f"version: {__version__}")
+
+
+__all__ = [ "Workspace" ]

azure/quantum/_client/_version.py

@@ -6,4 +6,4 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0.dev1"
+VERSION = "1.1.0"

azure/quantum/argument_types/__init__.py

@@ -2,6 +2,9 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 ##
+
+"""Defines argument types for Microsoft Estimator"""
+
 from .types import EmptyArray, Pauli, Range, Result
 
 __all__ = ['EmptyArray', 'Pauli', 'Range', 'Result']

azure/quantum/argument_types/types.py

@@ -7,6 +7,8 @@ from enum import Enum
 from typing import Optional, Type
 
 class Pauli(Enum):
+    """Pauli operators"""
+
     I = "PauliI"
     X = "PauliX"
     Y = "PauliY"
@@ -14,18 +16,32 @@ class Pauli(Enum):
 
 
 class Result(Enum):
+    """Result value"""
+
     Zero = False
     One = True
 
 
 @dataclass
 class Range:
+    """Range value
+    
+    :param start: Start
+    :type start: int
+    :param end: End
+    :type end: int
+    :param step: Step
+    :type step: int
+    """
+
     start: int
     end: int
     step: Optional[int] = None
 
     @property
     def value(self):
+        """Range value"""
+        
         if self.step is None:
             return {"start": self.start, "end": self.end}
         else:
@@ -33,4 +49,7 @@ class Range:
 
 @dataclass
 class EmptyArray:
+    """Empty array value"""
+    
     element_type: Type
+    """Element type"""

azure/quantum/cirq/__init__.py

@@ -2,4 +2,10 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 ##
+
+"""Azure Quantum Cirq Service"""
+
 from .service import AzureQuantumService
+from .job import Job
+
+__all__ = ["AzureQuantumService", "Job"]

azure/quantum/cirq/job.py

@@ -20,7 +20,15 @@ class Job:
         program: "cirq.Circuit",
         measurement_dict: dict = None
     ):
-        """Construct a Job."""
+        """Construct a Job.
+        
+        :param azure_job: Job
+        :type azure_job: azure.quantum.job.Job
+        :param program: Cirq program
+        :type program: cirq.Circuit
+        :param measurement_dict: Measurments
+        :type measurement_dict: dict
+        """
         self._azure_job = azure_job
         self._program = program
         self._measurement_dict = measurement_dict

azure/quantum/cirq/service.py

@@ -39,9 +39,9 @@ class AzureQuantumService:
         """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
         :param default_target: Default target name, defaults to None
-        :type default_target: Optional[str], optional
+        :type default_target: Optional[str]
         """
         if kwargs is not None and len(kwargs) > 0:
             from warnings import warn
@@ -80,9 +80,9 @@ class AzureQuantumService:
         """Get all quantum computing targets available in the Azure Quantum Workspace.
 
         :param name: Target name, defaults to None
-        :type name: str, optional
+        :type name: str
         :return: Target instance or list thereof
-        :rtype: Union[Target, List[Target]]
+        :rtype: typing.Union[Target, typing.List[Target]]
         """
         return self._target_factory.get_targets(
             name=name,
@@ -95,7 +95,7 @@ class AzureQuantumService:
         :param name: Target name
         :type name: str
         :return: Cirq target
-        :rtype: CirqTarget
+        :rtype: Target
         """
         if name is None:
             if self._default_target is None:
@@ -111,7 +111,7 @@ class AzureQuantumService:
         :param job_id: Job ID
         :type job_id: str
         :return: Job
-        :rtype: azure.quantum.cirq.Job or cirq_ionq.Job
+        :rtype: azure.quantum.cirq.Job
         """
         job = self._workspace.get_job(job_id=job_id)
         target : CirqTarget = self._target_factory.create_target(
@@ -168,6 +168,19 @@ see https://aka.ms/AQ/Docs/AddProvider")
         param_resolver: cirq.ParamResolverOrSimilarType = cirq.ParamResolver({}),
         **kwargs
     ):
+        """
+        Estimate the cost for a given circuit.
+
+        :param program: Cirq program or circuit
+        :type program: cirq.Circuit
+        :param repetitions: Number of measurement repetitions
+        :type repetitions: int
+        :param target: Target name, defaults to default_target
+        :type target: str
+        :param param_resolver: Cirq parameters, defaults to `cirq.ParamResolver({})`
+        :type param_resolver: cirq.ParamResolverOrSimilarType
+        """
+        
         # Resolve parameters
         resolved_circuit = cirq.resolve_parameters(program, param_resolver)
         target = self.get_target(name=target)
@@ -194,15 +207,15 @@ see https://aka.ms/AQ/Docs/AddProvider")
         :param repetitions: Number of measurement repetitions
         :type repetitions: int
         :param target: Target name, defaults to default_target
-        :type target: str, optional
+        :type target: str
         :param name: Program name, defaults to "cirq-job"
-        :type name: str, optional
-        :param param_resolver: Cirq parameters, defaults to cirq.ParamResolver({})
-        :type param_resolver: cirq.ParamResolverOrSimilarType, optional
+        :type name: str
+        :param param_resolver: Cirq parameters, defaults to `cirq.ParamResolver({})`
+        :type param_resolver: cirq.ParamResolverOrSimilarType
         :param seed: Random seed for simulator results, defaults to None
-        :type seed: cirq.RANDOM_STATE_OR_SEED_LIKE, optional
+        :type seed: cirq.RANDOM_STATE_OR_SEED_LIKE
         :param timeout_seconds: Timeout in seconds, defaults to None
-        :type timeout_seconds: int, optional
+        :type timeout_seconds: int
         :return: Measurement results
         :rtype: cirq.Result
         """

azure/quantum/cirq/targets/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License.
 ##
 
+"""Defines set of Cirq targets for interacting with Azure Quantum"""
+
 from azure.quantum.cirq.targets.target import Target
 from azure.quantum.cirq.targets.quantinuum import QuantinuumTarget
 from azure.quantum.cirq.targets.ionq import IonQTarget

azure/quantum/job/__init__.py

@@ -3,9 +3,26 @@
 # Licensed under the MIT License.
 ##
 
-from azure.quantum.job.job import Job
-from azure.quantum.job.job_failed_with_results_error import JobFailedWithResultsError
-from azure.quantum.job.workspace_item import WorkspaceItem
-from azure.quantum.job.workspace_item_factory import WorkspaceItemFactory
-from azure.quantum.job.session import Session, SessionHost
+"""Defines Azure Quantum job model"""
+
 from azure.quantum._client.models import JobDetails
+from .base_job import BaseJob
+from .filtered_job import FilteredJob
+from .job import Job
+from .job_failed_with_results_error import JobFailedWithResultsError
+from .workspace_item import WorkspaceItem
+from .workspace_item_factory import WorkspaceItemFactory
+from .session import Session, SessionHost, SessionDetails, SessionStatus, SessionJobFailurePolicy
+
+__all__ = [
+    "Job",
+    "JobDetails",
+    "BaseJob",
+    "FilteredJob",
+    "WorkspaceItem",
+    "Session",
+    "SessionHost",
+    "SessionDetails",
+    "SessionStatus",
+    "SessionJobFailurePolicy"
+    ]

azure/quantum/job/base_job.py

@@ -33,6 +33,12 @@ class BaseJob(WorkspaceItem):
     """
     Base job class with methods to create a job from raw blob data,
     upload blob data and download results.
+
+    :param workspace: Workspace instance of the job
+    :type workspace: Workspace
+    :param details: Item details model,
+            contains item ID, name and other details
+    :type details: ItemDetails
     """
 
     @staticmethod
@@ -42,6 +48,7 @@ class BaseJob(WorkspaceItem):
 
     @property
     def details(self) -> JobDetails:
+        """Job details"""
         return self._details
 
     @details.setter
@@ -50,6 +57,7 @@ class BaseJob(WorkspaceItem):
 
     @property
     def container_name(self):
+        """Job input/output data container name"""
         return f"job-{self.id}"
 
     @classmethod
@@ -74,7 +82,7 @@ class BaseJob(WorkspaceItem):
         """Create a new Azure Quantum job based on a raw input_data payload.
 
         :param workspace: Azure Quantum workspace to submit the input_data to
-        :type workspace: "Workspace"
+        :type workspace: Workspace
         :param name: Name of the job
         :type name: str
         :param target: Azure Quantum target
@@ -88,17 +96,17 @@ class BaseJob(WorkspaceItem):
         :param encoding: input_data encoding, e.g. "gzip", defaults to empty string
         :type encoding: str
         :param job_id: Job ID, defaults to None
-        :type job_id: str, optional
+        :type job_id: str
         :param container_name: Container name, defaults to None
         :type container_name: str
         :param provider_id: Provider ID, defaults to None
-        :type provider_id: str, optional
+        :type provider_id: str
         :param input_data_format: Input data format, defaults to None
-        :type input_data_format: str, optional
+        :type input_data_format: str
         :param output_data_format: Output data format, defaults to None
-        :type output_data_format: str, optional
+        :type output_data_format: str
         :param input_params: Input parameters, defaults to None
-        :type input_params: Dict[str, Any], optional
+        :type input_params: Dict[str, Any]
         :param input_params: Input params for job
         :type input_params: Dict[str, Any]
         :return: Azure Quantum Job
@@ -161,7 +169,7 @@ class BaseJob(WorkspaceItem):
         to blob storage
 
         :param workspace: Azure Quantum workspace to submit the blob to
-        :type workspace: "Workspace"
+        :type workspace: Workspace
         :param name: Job name
         :type name: str
         :param target: Azure Quantum target
@@ -169,17 +177,17 @@ class BaseJob(WorkspaceItem):
         :param input_data_uri: Input data URI
         :type input_data_uri: str
         :param provider_id: Provider ID
-        :type provider_id: str, optional
+        :type provider_id: str
         :param input_data_format: Input data format
-        :type input_data_format: str, optional
+        :type input_data_format: str
         :param output_data_format: Output data format
-        :type output_data_format: str, optional
+        :type output_data_format: str
         :param container_uri: Container URI, defaults to None
         :type container_uri: str
         :param job_id: Pre-generated job ID, defaults to None
         :type job_id: str
         :param input_params: Input parameters, defaults to None
-        :type input_params: Dict[str, Any], optional
+        :type input_params: Dict[str, Any]
         :param submit_job: If job should be submitted to the service, defaults to True
         :type submit_job: bool
         :return: Job instance
@@ -212,7 +220,7 @@ class BaseJob(WorkspaceItem):
         job = cls(workspace, details, **kwargs)
 
         logger.info(
-            f"Submitting problem '{name}'. \
+            f"Submitting job '{name}'. \
                 Using payload from: '{job.details.input_data_uri}'"
         )
 
@@ -240,11 +248,11 @@ class BaseJob(WorkspaceItem):
         :param content_type: Content type, e.g. "application/json"
         :type content_type: Optional, ContentType
         :param blob_name: Blob name, defaults to "inputData"
-        :type blob_name: str, optional
+        :type blob_name: str
         :param encoding: Encoding, e.g. "gzip", defaults to ""
-        :type encoding: str, optional
+        :type encoding: str
         :param return_sas_token: Flag to return SAS token as part of URI, defaults to False
-        :type return_sas_token: bool, optional
+        :type return_sas_token: bool
         :return: Uploaded data URI
         :rtype: str
         """
@@ -306,7 +314,7 @@ class BaseJob(WorkspaceItem):
         :param data: Attachment data in binary format
         :type input_data: bytes
         :param container_uri: Container URI, defaults to the job's linked container.
-        :type container_uri: str, Optional
+        :type container_uri: str
 
         :return: Uploaded data URI
         :rtype: str
@@ -336,7 +344,7 @@ class BaseJob(WorkspaceItem):
         :param name: Attachment name
         :type name: str
         :param container_uri: Container URI, defaults to the job's linked container.
-        :type container_uri: str, Optional
+        :type container_uri: str
 
         :return: Attachment data
         :rtype: bytes

azure/quantum/job/filtered_job.py

@@ -22,9 +22,15 @@ class FilteredJob(abc.ABC):
         created_after: Optional[datetime] = None
     ) -> bool:
         """Checks if job (self) matches the given properties if any.
+
             :param name_match: regex expression for job name matching
+            :type name_match: str
             :param status: filter by job status
+            :type status: Optional[JobStatus]
             :param created_after: filter jobs after time of job creation
+            :type status: Optional[datetime]
+            :return: Is filter match
+            :rtype: bool
         """
         if name_match is not None and re.search(name_match, self.details.name) is None:
            return False

azure/quantum/job/job.py

@@ -74,11 +74,11 @@ class Job(BaseJob, FilteredJob):
         until it reaches a finished status.
 
         :param max_poll_wait_secs: Maximum poll wait time, defaults to 30
-        :type max_poll_wait_secs: int, optional
+        :type max_poll_wait_secs: int
         :param timeout_secs: Timeout in seconds, defaults to None
-        :type timeout_secs: int, optional
+        :type timeout_secs: int
         :param print_progress: Print "." to stdout to display progress
-        :type print_progress: bool, optional
+        :type print_progress: bool
         :raises TimeoutError: If the total poll time exceeds timeout, raise
         """
         self.refresh()
@@ -107,7 +107,7 @@ class Job(BaseJob, FilteredJob):
         storage container linked via the workspace.
 
         :param timeout_secs: Timeout in seconds, defaults to 300
-        :type timeout_secs: int
+        :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.
         """

azure/quantum/job/session.py

@@ -103,6 +103,7 @@ class Session(WorkspaceItem):
     @property
     def details(self) -> SessionDetails:
         """Get the session details.
+
         :return: The details about the session.
         :rtype: SessionDetails
         """
@@ -111,6 +112,7 @@ class Session(WorkspaceItem):
     @details.setter
     def details(self, value: SessionDetails):
         """Set session details.
+        
         :param value: The details about the session
         :type value: SessionDetails
         """
@@ -119,6 +121,7 @@ class Session(WorkspaceItem):
     @property
     def target(self) -> "Target":
         """Get the target associated with the session.
+
         :return: The target associated with the session.
         :rtype: Target
         """
@@ -157,7 +160,7 @@ class Session(WorkspaceItem):
         """Lists all jobs associated with this session.
 
         :return: A list of all jobs associated with this session.
-        :rtype: List[Job]
+        :rtype: typing.List[Job]
         """
         return self.workspace.list_session_jobs(session_id=self.id)
 
@@ -199,10 +202,15 @@ class SessionHost(Protocol):
     with that session.
 
     Example (job 1 to 3 will be associated the session "MySession"):
-        with target.open_session(name="MySession") as session:
+
+    .. highlight:: python
+    .. code-block::
+
+       with target.open_session(name="MySession") as session:
             job1 = target.submit(input_data=input_data, job_name="Job 1")
             job2 = target.submit(input_data=input_data, job_name="Job 2")
             job3 = target.submit(input_data=input_data, job_name="Job 3")
+    
     """
 
     _latest_session: Optional[Session] = None
@@ -212,7 +220,7 @@ class SessionHost(Protocol):
         """Get the latest (open) session associated with this object.
 
         :return: The latest session object.
-        :rtype: Optional[Session]
+        :rtype: typing.Optional[Session]
         """
         return self._latest_session
 
@@ -229,7 +237,7 @@ class SessionHost(Protocol):
            This id is used to associate jobs to the latest (open) session.
 
         :return: The latest session id.
-        :rtype: Optional[str]
+        :rtype: typing.Optional[str]
         """
         return self.latest_session.id if self.latest_session else None
 
@@ -258,7 +266,11 @@ class SessionHost(Protocol):
            after exiting a `with` block).
 
         Example (job 1 to 3 will be associated the session "MySession"):
-            with target.open_session(name="MySession") as session:
+
+        .. highlight:: python
+        .. code-block::
+
+           with target.open_session(name="MySession") as session:
                 job1 = target.submit(input_data=input_data, job_name="Job 1")
                 job2 = target.submit(input_data=input_data, job_name="Job 2")
                 job3 = target.submit(input_data=input_data, job_name="Job 3")
@@ -273,7 +285,6 @@ class SessionHost(Protocol):
                         Either this parameter should be passed containing all
                         the session detail values, the same values should be
                         passed as individual parameters.
-        :type details: Optional[SessionDetails]
 
         :param id: The id of the session. If not passed, one random uuid will used.
         :type id: Optional[str]
@@ -284,7 +295,6 @@ class SessionHost(Protocol):
 
         :param job_failure_policy: The policy that determines when a session would fail,
                                 close and not accept further jobs.
-        :type job_failure_policy: Union[str, SessionJobFailurePolicy, None]
 
         :return: The session object with updated details after its opening.
         :rtype: Session

azure/quantum/job/workspace_item.py

@@ -16,12 +16,13 @@ __all__ = ["WorkspaceItem"]
 
 class WorkspaceItem(abc.ABC):
     """
+    Workspace item base class.
 
     :param workspace: Workspace instance to submit job to
     :type workspace: Workspace
-    :param item_details: Item details model,
+    :param details: Item details model,
             contains item ID, name and other details
-    :type item_details: ItemDetails
+    :type details: ItemDetails
     """
 
     def __init__(self, workspace: "Workspace", details: ItemDetails, **kwargs):
@@ -31,16 +32,20 @@ class WorkspaceItem(abc.ABC):
 
     @property
     def workspace(self) -> "Workspace":
+        """Workspace of the Workspace item"""
         return self._workspace
 
     @property
     def details(self) -> Union[SessionDetails, JobDetails]:
+        """Workspace item details"""
         return self._details
 
     @property
     def id(self) -> str:
+        """Id of the Workspace item"""
         return self._details.id
 
     @property
     def item_type(self) -> ItemType:
+        """Workspace item type"""
         return self._item_type

azure/quantum/qiskit/backends/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License.
 ##
 
+"""Defines set of backends for interacting with Azure Quantum"""
+
 from azure.quantum.qiskit.backends.ionq import (
     IonQBackend,
     IonQQPUBackend,

azure/quantum/qiskit/backends/backend.py

@@ -26,7 +26,7 @@ try:
     from qiskit.providers import Options
     from qiskit.providers import Provider
     from qiskit.providers.models import BackendConfiguration
-    from qiskit.qobj import Qobj, QasmQobj
+    from qiskit.qobj import QasmQobj, PulseQobj
     from pyqir import Module
     from qiskit_qir import to_qir_module
 
@@ -121,7 +121,7 @@ class AzureBackendBase(Backend, SessionHost):
 
         return output_data_format
     
-    def _get_input_params(self, options, shots: int = None) -> Dict[str, Any]:
+    def _get_input_params(self, options: Dict[str, Any], shots: int = None) -> Dict[str, Any]:
         # Backend options are mapped to input_params.
         input_params: Dict[str, Any] = vars(self.options).copy()
 
@@ -132,7 +132,7 @@ class AzureBackendBase(Backend, SessionHost):
             # First we check for the explicitly specified 'shots' parameter, then for a provider-specific
             # field in options, then for a backend's default value. 
 
-            # Warn abount options conflict, default to 'shots'.
+            # Warn about options conflict, default to 'shots'.
             if shots is not None and options_shots is not None:
                 warnings.warn(
                     f"Parameter 'shots' conflicts with the '{self.__class__._SHOTS_PARAM_NAME}' parameter. "
@@ -159,6 +159,10 @@ class AzureBackendBase(Backend, SessionHost):
             input_params["shots"] = final_shots
             input_params["count"] = final_shots
 
+            # Safely removing "shots" and "count" from options as they will be passed in input_params now.
+            _ = options.pop("shots", None)
+            _ = options.pop("count", None)
+
             input_params[self.__class__._SHOTS_PARAM_NAME] = final_shots
             
 
@@ -468,13 +472,13 @@ class AzureBackend(AzureBackendBase):
 
         # If the circuit was created using qiskit.assemble,
         # disassemble into QASM here
-        if isinstance(circuit, QasmQobj) or isinstance(circuit, Qobj):
+        if isinstance(circuit, QasmQobj) or isinstance(circuit, PulseQobj):
             from qiskit.assembler import disassemble
 
             circuits, run, _ = disassemble(circuit)
             circuit = circuits[0]
             if options.get("shots") is None:
-                # Note that the default number of shots for QObj is 1024
+                # Note that qiskit.assembler.disassemble() sets the default number of shots for QasmQobj and PulseQobj to 1024
                 # unless the user specifies the backend.
                 options["shots"] = run["shots"]
 

azure/quantum/qiskit/backends/quantinuum.py

@@ -270,7 +270,7 @@ class QuantinuumBackend(AzureBackend):
         input_data = circuit.qasm()
         workspace = self.provider().get_workspace()
         target = workspace.get_targets(self.name())
-        return target.estimate_cost(input_data, shots)
+        return target.estimate_cost(input_data, shots=shots)
 
     def _get_n_qubits(self, name):
         return _get_n_qubits(name)