azure-quantum 0.30.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

azure/quantum/aio/target/ionq.py

@@ -1,47 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-from typing import Any, Dict
-
-from azure.quantum.aio.target.target import Target
-from azure.quantum.aio.job.job import Job
-from azure.quantum.target import IonQ as SyncIonQ
-
-
-class IonQ(Target, SyncIonQ):
-    """IonQ target."""
-
-    async def submit(
-        self,
-        circuit: Dict[str, Any],
-        name: str = "ionq-job",
-        num_shots: int = None,
-        input_params: Dict[str, Any] = None,
-        **kwargs
-    ) -> Job:
-        """Submit an IonQ circuit (JSON format)
-
-        :param circuit: Quantum circuit in IonQ JSON format
-        :type circuit: Dict[str, Any]
-        :param name: Job name
-        :type name: str
-        :param num_shots: Number of shots, defaults to None
-        :type num_shots: int
-        :param input_params: Optional input params dict
-        :type input_params: Dict[str, Any]
-        :return: Azure Quantum job
-        :rtype: Job
-        """
-        if input_params is None:
-            input_params = {}
-        if num_shots is not None:
-            input_params = input_params.copy()
-            input_params["shots"] = num_shots
-
-        return await super().submit(
-            input_data=circuit,
-            name=name,
-            input_params=input_params,
-            **kwargs
-        )

azure/quantum/aio/target/quantinuum.py

@@ -1,47 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-##
-from typing import Any, Dict
-
-from azure.quantum.aio.target.target import Target
-from azure.quantum.aio.job.job import Job
-from azure.quantum.target import Quantinuum as SyncQuantinuum
-
-
-class Quantinuum(Target, SyncQuantinuum):
-    """Quantinuum target."""
-
-    async def submit(
-        self,
-        circuit: str,
-        name: str = "quantinuum-job",
-        num_shots: int = None,
-        input_params: Dict[str, Any] = None,
-        **kwargs
-    ) -> Job:
-        """Submit a Quantinuum program (OpenQASM 2.0 format)
-
-        :param circuit: Quantum circuit in Quantinuum OpenQASM 2.0 format
-        :type circuit: str
-        :param name: Job name
-        :type name: str
-        :param num_shots: Number of shots, defaults to None
-        :type num_shots: int
-        :param input_params: Optional input params dict
-        :type input_params: Dict[str, Any]
-        :return: Azure Quantum job
-        :rtype: Job
-        """
-        if input_params is None:
-            input_params = {}
-        if num_shots is not None:
-            input_params = input_params.copy()
-            input_params["count"] = num_shots
-
-        return await super().submit(
-            input_data=circuit,
-            name=name,
-            input_params=input_params,
-            **kwargs
-        )

azure/quantum/aio/target/solvers.py

@@ -1,96 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-import logging
-
-from typing import TYPE_CHECKING, Union
-from azure.quantum.aio import Workspace, Job
-from azure.quantum.aio.target.target import Target
-from azure.quantum.target.solvers import Solver as SyncSolver
-from azure.quantum.aio.job.base_job import DEFAULT_TIMEOUT
-
-if TYPE_CHECKING:
-    from azure.quantum.aio.optimization.problem import Problem
-
-logger = logging.getLogger(__name__)
-
-__all__ = [
-    "RangeSchedule",
-    "Solver",
-]
-
-
-class Solver(Target, SyncSolver):
-
-    workspace: Workspace
-
-    async def submit(
-        self, problem: Union[str, "Problem"]
-    ) -> Job:
-        """Submits a job to execution to the associated
-        Azure Quantum Workspace.
-
-        :param problem:
-            The Problem to solve. It can be an instance of a Problem,
-            or the URL of an Azure Storage Blob where the serialized version
-            of a Problem has been uploaded.
-        """
-        from azure.quantum.aio.optimization.problem import Problem
-        if isinstance(problem, Problem):
-            # Create job from input data
-            return await super().submit(
-                input_data=problem,
-                name=problem.name,
-                input_params=self.params,
-                blob_name="inputData",
-                content_type = problem.content_type
-            )
-        
-        else:
-            if hasattr(problem, "uploaded_blob_uri"):
-                name = problem.name
-                problem_uri = problem.uploaded_blob_uri
-
-            elif isinstance(problem, str):
-                name = "Optimization problem"
-                problem_uri = problem
-            
-            else:
-                raise ValueError("Cannot submit problem: should be of type str, Problem or have uploaded_blob_uri attribute.")
-
-            # Create job from storage URI
-            job = await Job.from_storage_uri(
-                workspace=self.workspace,
-                name=name,
-                target=self.name,
-                input_data_uri=problem_uri,
-                provider_id=self.provider_id,
-                input_data_format=self.input_data_format,
-                output_data_format=self.output_data_format,
-                input_params=self.params
-            )
-
-        return job
-
-    async def optimize(self, problem: Union[str, "Problem"], timeout_secs: int=DEFAULT_TIMEOUT):
-        """[Submits the Problem to the associated
-            Azure Quantum Workspace and get the results.
-
-        :param problem:
-            The Problem to solve. It can be an instance of a Problem,
-            or the URL of an Azure Storage Blob where the serialized version
-            of a Problem has been uploaded.
-        :type problem: Union[str, Problem]
-        :param timeout_secs: Timeout in seconds, defaults to 300
-        :type timeout_secs: int
-        :return: Job results
-        :rtype: dict
-        """
-        if not isinstance(problem, str):
-            self.check_submission_warnings(problem)
-
-        job = await self.submit(problem)
-        logger.info(f"Submitted job: '{job.id}'")
-
-        return await job.get_results(timeout_secs=timeout_secs)

azure/quantum/aio/target/target.py

@@ -1,68 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-import abc
-from typing import Any, Dict
-
-
-from azure.quantum.aio.job.job import Job
-from azure.quantum.target import Target as SyncTarget
-from azure.quantum.aio.workspace import Workspace
-
-
-class Target(SyncTarget, abc.ABC):
-    """Azure Quantum Target."""
-    workspace: Workspace
-
-    async def submit(
-        self,
-        input_data: Any,
-        name: str = "azure-quantum-job",
-        input_params: Dict[str, Any] = None,
-        **kwargs
-    ) -> Job:
-        """Submit input data and return Job
-
-        :param input_data: Input data
-        :type input_data: Any
-        :param name: Job name
-        :type name: str
-        :param input_params: Input parameters
-        :type input_params: Dict[str, Any]
-        :return: Azure Quantum job
-        :rtype: Job
-        """
-        input_params = input_params or {}
-        input_data_format = kwargs.pop("input_data_format", self.input_data_format)
-        output_data_format = kwargs.pop("output_data_format", self.output_data_format)
-        content_type = kwargs.pop("content_type", self.content_type)
-        encoding = kwargs.pop("encoding", self.encoding)
-        blob = self._encode_input_data(data=input_data)
-
-        return await Job.from_input_data(
-            workspace=self.workspace,
-            name=name,
-            target=self.name,
-            input_data=blob,
-            content_type=content_type,
-            encoding=encoding,
-            provider_id=self.provider_id,
-            input_data_format=input_data_format,
-            output_data_format=output_data_format,
-            input_params=input_params,
-            **kwargs
-        )
-
-    async def refresh(self):
-        """Update the target availability and queue time"""
-        targets = await self.workspace._get_target_status(self.name, self.provider_id)
-        if len(targets) > 0:
-            _, target_status = targets[0]
-            self._current_availability = target_status.current_availability
-            self._average_queue_time = target_status.average_queue_time
-        else:
-            raise ValueError(
-                f"Cannot refresh the Target status: \
-target '{self.name}' of provider '{self.provider_id}' not found."
-            )

azure/quantum/aio/target/target_factory.py

@@ -1,72 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-from typing import Dict, List, TYPE_CHECKING, Union
-from azure.quantum.aio.target import Target as AsyncTarget
-from azure.quantum.aio.target import *
-from azure.quantum.target.target_factory import TargetFactory as SyncTargetFactory
-
-if TYPE_CHECKING:
-    from azure.quantum.aio import Workspace
-
-# Target ID keyword for parameter-free solvers
-PARAMETER_FREE = "parameterfree"
-
-
-class TargetFactory(SyncTargetFactory):
-    """Factory class for generating a Target based on a
-    provider and target name
-    """
-    __instance = None
-    def __new__(cls, *args, **kwargs):
-        if cls.__instance is None:
-            cls.__instance = super().__new__(cls, *args, **kwargs)
-        return cls.__instance
-
-    @staticmethod
-    def _get_all_target_cls() -> Dict[str, Target]:
-        """Get all target classes by target name"""
-        return {
-            name: _t for t in AsyncTarget.__subclasses__()
-            for _t in [t] + t.__subclasses__()
-            for name in _t.target_names
-        }
-
-    async def get_targets(
-        self,
-        workspace: "Workspace",
-        name: str,
-        provider_id: str,
-        **kwargs
-    ) -> Union[Target, List[Target]]:
-        """Create targets that are available to this workspace
-        filtered by name and provider ID.
-
-        :param name: Target name
-        :type name: str
-        :param workspace: Workspace
-        :type workspace: Workspace
-        :param provider_id: Provider name
-        :type provider_id: str
-        :return: One or more Target objects
-        :rtype: Union[Target, List[Target]]
-        """
-        target_statuses = await workspace._get_target_status(name, provider_id, **kwargs)
-
-        if len(target_statuses) == 1:
-            _, status = target_statuses[0]
-            return self.from_target_status(workspace, status=status)
-
-        else:
-            # Don't return redundant parameter-free 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
-                    or status.id in self._all_targets
-                )
-            ]
-

azure/quantum/aio/target/toshiba.py

@@ -1,6 +0,0 @@
-from azure.quantum.aio.target.solvers import Solver
-from azure.quantum.target.toshiba import SimulatedBifurcationMachine as SyncSimulatedBifurcationMachine
-
-
-class SimulatedBifurcationMachine(SyncSimulatedBifurcationMachine, Solver):
-    pass

azure/quantum/aio/workspace.py

@@ -1,337 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-from datetime import datetime
-import logging
-import re
-import os
-
-from typing import Iterable, List, Optional, Dict, Any, TYPE_CHECKING, Tuple, Union
-
-from azure.quantum.aio._authentication._default import _DefaultAzureCredential
-from azure.quantum._client.aio import QuantumClient
-from azure.quantum._client.models import BlobDetails, JobStatus
-from azure.quantum.aio.job import Job
-from azure.quantum.aio.storage import create_container_using_client, get_container_uri, ContainerClient
-
-from azure.quantum.workspace import BASE_URL, ARM_BASE_URL, USER_AGENT_APPID_ENV_VAR_NAME
-
-if TYPE_CHECKING:
-    from azure.quantum.aio.target import Target
-    from azure.quantum._client.models import TargetStatus
-
-logger = logging.getLogger(__name__)
-
-DEFAULT_CONTAINER_NAME_FORMAT = "job-{job_id}"
-
-__all__ = ["Workspace"]
-
-
-class Workspace:
-    """Represents an Azure Quantum workspace.
-
-    When creating a Workspace object, callers have two options for identifying
-    the Azure Quantum workspace:
-    1. specify a valid resource ID, or
-    2. specify a valid subscription ID, resource group, and workspace name.
-
-    If the Azure Quantum workspace does not have linked storage, the caller
-    must also pass a valid Azure storage account connection string.
-
-    :param subscription_id:
-        The Azure subscription ID. Ignored if resource_id is specified.
-
-    :param resource_group:
-        The Azure resource group name. Ignored if resource_id is specified.
-
-    :param name:
-        The Azure Quantum workspace name. Ignored if resource_id is specified.
-
-    :param storage:
-        The Azure storage account connection string.
-        Required only if the specified Azure Quantum
-        workspace does not have linked storage.
-
-    :param resource_id:
-        The resource ID of the Azure Quantum workspace.
-
-    :param location:
-        The Azure region where the Azure Quantum workspace is provisioned.
-        This may be specified as a region name such as
-        \"East US\" or a location name such as \"eastus\".
-
-    :param credential:
-        The credential to use to connect to Azure services.
-        Normally one of the credential types from Azure.Identity (https://docs.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes).
-
-        Defaults to \"DefaultAzureCredential\", which will attempt multiple 
-        forms of authentication.
-
-    :param user_agent:
-        Add the specified value as a prefix to the HTTP User-Agent header when communicating to the Azure Quantum service.
-    """
-
-    credentials = None
-
-    def __init__(
-        self,
-        subscription_id: Optional[str] = None,
-        resource_group: Optional[str] = None,
-        name: Optional[str] = None,
-        storage: Optional[str] = None,
-        resource_id: Optional[str] = None,
-        location: Optional[str] = None,
-        credential: Optional[object] = None,
-        user_agent: Optional[str] = None,
-    ):
-        if resource_id is not None:
-            # A valid resource ID looks like:
-            # /subscriptions/f846b2bd-d0e2-4a1d-8141-4c6944a9d387/resourceGroups/
-            # RESOURCE_GROUP_NAME/providers/Microsoft.Quantum/Workspaces/WORKSPACE_NAME
-            regex = r"^/subscriptions/([a-fA-F0-9-]*)/resourceGroups/([^\s/]*)/providers/Microsoft\.Quantum/Workspaces/([^\s/]*)$"
-            match = re.search(regex, resource_id, re.IGNORECASE)
-            if match:
-                # match should contain four groups:
-                # -> match.group(0):
-                # The full resource ID for the Azure Quantum workspace
-                # -> match.group(1): The Azure subscription ID
-                # -> match.group(2): The Azure resource group name
-                # -> match.group(3): The Azure Quantum workspace name
-                subscription_id = match.group(1)
-                resource_group = match.group(2)
-                name = match.group(3)
-
-        if not subscription_id or not resource_group or not name:
-            raise ValueError(
-                "Azure Quantum workspace not fully specified."
-                + "Please specify either a valid resource ID "
-                + "or a valid combination of subscription ID,"
-                + "resource group name, and workspace name."
-            )
-
-        if not location:
-            raise ValueError(
-                "Azure Quantum workspace does not have an associated location. " +
-                "Please specify the location associated with your workspace.")
-
-        # Temporarily using a custom _DefaultAzureCredential
-        # instead of Azure.Identity.DefaultAzureCredential
-        # See _DefaultAzureCredential documentation for more info.
-        if credential is None:
-            credential = _DefaultAzureCredential(exclude_interactive_browser_credential=False,
-                                                 exclude_shared_token_cache_credential=True,
-                                                 subscription_id=subscription_id,
-                                                 arm_base_url=ARM_BASE_URL)
-
-        self.credentials = credential
-        self.name = name
-        self.resource_group = resource_group
-        self.subscription_id = subscription_id
-        self.storage = storage
-        self._user_agent = user_agent
-        self.append_user_agent("async")
-
-        # Convert user-provided location into names
-        # recognized by Azure resource manager.
-        # For example, a customer-provided value of
-        # "West US" should be converted to "westus".
-        self.location = "".join(location.split()).lower()
-
-    def _create_client(self) -> QuantumClient:
-        endpoint = BASE_URL(self.location)
-        logger.debug(
-            f"Creating client for: subs:{self.subscription_id},"
-            + f"rg={self.resource_group}, ws={self.name}, frontdoor={endpoint}"
-        )
-
-        client = QuantumClient(
-            credential=self.credentials,
-            subscription_id=self.subscription_id,
-            resource_group_name=self.resource_group,
-            workspace_name=self.name,
-            endpoint=endpoint,
-            user_agent=self.user_agent
-        )
-        return client
-
-    @property
-    def user_agent(self):
-        """
-        Get the Workspace's UserAgent that is sent to the service via the header.
-        Uses the value specified during initialization and appends the environment
-        variable AZURE_QUANTUM_PYTHON_APPID if specified.
-        """
-        full_user_agent = self._user_agent
-        env_app_id = os.environ.get(USER_AGENT_APPID_ENV_VAR_NAME)
-        if env_app_id:
-            full_user_agent = f"{full_user_agent}-{env_app_id}" if full_user_agent else env_app_id
-        return full_user_agent
-
-    def append_user_agent(self, value: str):
-        """
-        Append a new value to the Workspace's UserAgent and re-initialize the
-        QuantumClient. The values are appended using a dash.
-        
-        :param value: UserAgent value to add, e.g. "azure-quantum-<plugin>"
-        """
-        if value not in (self._user_agent or ""):
-            new_user_agent = f"{self._user_agent}-{value}" if self._user_agent else value
-            if new_user_agent != self._user_agent:
-                self._user_agent = new_user_agent
-
-    async def _get_linked_storage_sas_uri(
-        self, container_name: str, blob_name: str = None
-    ) -> str:
-        """
-        Calls the service and returns a container sas url
-        """
-        blob_details = BlobDetails(
-            container_name=container_name, blob_name=blob_name
-        )
-        client = self._create_client()
-        storage = client.storage
-        container_uri = await storage.sas_uri(blob_details=blob_details)
-        await client.close()
-        logger.debug(f"Container URI from service: {container_uri}")
-        return container_uri.sas_uri
-
-    async def submit_job(self, job: Job) -> Job:
-        client = self._create_client()
-        details = await client.jobs.create(
-            job.details.id, job.details
-        )
-        await client.close()
-        return Job(self, details)
-
-    async def cancel_job(self, job: Job) -> Job:
-        client = self._create_client()
-        await client.jobs.cancel(job.details.id)
-        details = await client.jobs.get(job.id)
-        await client.close()
-        return Job(self, details)
-
-    async def get_job(self, job_id: str) -> Job:
-        """Returns the job corresponding to the given id."""
-        client = self._create_client()
-        details = await client.jobs.get(job_id)
-        await client.close()
-        return Job(self, details)
-
-    async def list_jobs(
-        self,
-        name_match: str = None,
-        status: Optional[JobStatus] = None,
-        created_after: Optional[datetime] = None
-    ) -> List[Job]:
-        """Returns list of jobs that meet optional (limited) filter criteria. 
-            :param name_match: regex expression for job name matching
-            :param status: filter by job status
-            :param created_after: filter jobs after time of job creation
-        """
-        client = self._create_client()
-        jobs = client.jobs.list()
-
-        result = []
-        async for j in jobs:
-            deserialized_job = Job(self, j)
-            if deserialized_job.matches_filter(name_match, status, created_after):
-                result.append(deserialized_job)
-        await client.close()
-        return result
-    
-    async def _get_target_status(self, name: str, provider_id: str) -> List[Tuple[str, "TargetStatus"]]:
-        """Get provider ID and status for targets"""
-        client = self._create_client()
-        result = [
-            (provider.id, target)
-            async for provider in client.providers.get_status()
-            for target in provider.targets
-            if (provider_id is None or provider.id.lower() == provider_id.lower())
-                and (name is None or target.id.lower() == name.lower())
-        ]
-        await client.close()
-        return result
-
-    async def get_targets(
-        self, 
-        name: str = None, 
-        provider_id: str = None,
-        **kwargs
-    ) -> Union["Target", Iterable["Target"]]:
-        """Returns all available targets for this workspace filtered by name and provider ID.
-        
-        :param name: Optional target name to filter by, defaults to None
-        :type name: str, optional
-        :param provider_id: Optional provider Id to filter by, defaults to None
-        :type provider_id: str, optional
-        :return: Targets
-        :rtype: Iterable[Target]
-        """
-        from azure.quantum.aio.target.target_factory import TargetFactory
-        from azure.quantum.aio.target import Target
-
-        target_factory = TargetFactory(
-            base_cls=Target,
-            workspace=self
-        )
-
-        return await target_factory.get_targets(
-            workspace=self,
-            name=name,
-            provider_id=provider_id
-        )
-
-    async def get_quotas(self) -> List[Dict[str, Any]]:
-        """Get a list of job quotas for the given workspace.
-
-        :return: Job quotas
-        :rtype: List[Dict[str, Any]]
-        """
-        client = self._create_client()
-        result = [q.as_dict() async for q in client.quotas.list()]
-        await client.close()
-        return result
-
-    async def get_container_uri(
-        self,
-        job_id: str = None,
-        container_name: str = None,
-        container_name_format: str = DEFAULT_CONTAINER_NAME_FORMAT
-    ) -> str:
-        """Get container URI based on job ID or container name.
-        Creates a new container if it does not yet exist.
-
-        :param job_id: Job ID, defaults to None
-        :type job_id: str, optional
-        :param container_name: Container name, defaults to None
-        :type container_name: str, optional
-        :param container_name_format: Container name format, defaults to "job-{job_id}"
-        :type container_name_format: str, optional
-        :return: Container URI
-        :rtype: str
-        """
-        if container_name is None:
-            if job_id is not None:
-                container_name = container_name_format.format(job_id=job_id)
-            elif job_id is None:
-                container_name = f"{self.name}-data"
-        # Create container URI and get container client
-        if self.storage is None:
-            # Get linked storage account from the service, create
-            # a new container if it does not yet exist
-            container_uri = await self._get_linked_storage_sas_uri(
-                container_name
-            )
-            container_client = ContainerClient.from_container_url(
-                container_uri
-            )
-            await create_container_using_client(container_client)
-            await container_client.close()
-        else:
-            # Use the storage acount specified to generate container URI,
-            # create a new container if it does not yet exist
-            container_uri = await get_container_uri(
-                self.storage, container_name
-            )
-        return container_uri