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

azure/quantum/aio/job/base_job.py

@@ -1,326 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-import logging
-
-from urllib.parse import urlparse
-from typing import Any, Dict, Optional, TYPE_CHECKING
-from urllib.parse import urlparse
-from azure.storage.blob import BlobClient
-
-from azure.quantum.aio.storage import upload_blob, download_blob, ContainerClient
-from azure.quantum._client.models import JobDetails
-from azure.quantum.job.job import BaseJob as SyncBaseJob, ContentType
-
-
-if TYPE_CHECKING:
-    from azure.quantum.aio.workspace import Workspace
-
-
-logger = logging.getLogger(__name__)
-
-DEFAULT_TIMEOUT = 300  # Default timeout for waiting for job to complete
-
-
-class BaseJob(SyncBaseJob):
-    # Optionally override these to create a Provider-specific Job subclass
-    """
-    Base job class with methods to create a job from raw blob data,
-    upload blob data and download results.
-    """
-    @classmethod
-    async def from_input_data(
-        cls,
-        workspace: "Workspace",
-        name: str,
-        target: str,
-        input_data: bytes,
-        content_type: str,
-        blob_name: str = "inputData",
-        encoding: str = "",
-        job_id: str = None,
-        container_name: str = None,
-        provider_id: str = None,
-        input_data_format: str = None,
-        output_data_format: str = None,
-        input_params: Dict[str, Any] = None,
-        **kwargs
-    ) -> "BaseJob":
-        """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"
-        :param name: Name of the job
-        :type name: str
-        :param target: Azure Quantum target
-        :type target: str
-        :param input_data: Raw input data to submit
-        :type input_data: bytes
-        :param blob_name: Input data blob name, defaults to "inputData"
-        :type blob_name: str
-        :param content_type: Content type, e.g. "application/json"
-        :type content_type: str
-        :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
-        :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
-        :param input_data_format: Input data format, defaults to None
-        :type input_data_format: str, optional
-        :param output_data_format: Output data format, defaults to None
-        :type output_data_format: str, optional
-        :param input_params: Input parameters, defaults to None
-        :type input_params: Dict[str, Any], optional
-        :param input_params: Input params for job
-        :type input_params: Dict[str, Any]
-        :return: Azure Quantum Job
-        :rtype: Job
-        """
-        # Generate job ID if not specified
-        if job_id is None:
-            job_id = cls.create_job_id()
-
-        # Create container if it does not yet exist
-        container_uri = await workspace.get_container_uri(
-            job_id=job_id,
-            container_name=container_name
-        )
-        logger.debug(f"Container URI: {container_uri}")
-
-        # Upload data to container
-        input_data_uri = await cls.upload_input_data(
-            container_uri=container_uri,
-            input_data=input_data,
-            content_type=content_type,
-            blob_name=blob_name,
-            encoding=encoding
-        )
-
-        # Create and submit job
-        return await cls.from_storage_uri(
-            workspace=workspace,
-            job_id=job_id,
-            target=target,
-            input_data_uri=input_data_uri,
-            container_uri=container_uri,
-            name=name,
-            input_data_format=input_data_format,
-            output_data_format=output_data_format,
-            provider_id=provider_id,
-            input_params=input_params,
-            **kwargs
-        )
-
-    @classmethod
-    async def from_storage_uri(
-        cls,
-        workspace: "Workspace",
-        name: str,
-        target: str,
-        input_data_uri: str,
-        provider_id: str,
-        input_data_format: str,
-        output_data_format: str,
-        container_uri: str = None,
-        job_id: str = None,
-        input_params: Dict[str, Any] = None,
-        submit_job: bool = True,
-        **kwargs
-    ) -> "BaseJob":
-        """Create new Job from URI if input data is already uploaded
-        to blob storage
-
-        :param workspace: Azure Quantum workspace to submit the blob to
-        :type workspace: "Workspace"
-        :param name: Job name
-        :type name: str
-        :param target: Azure Quantum target
-        :type target: str
-        :param input_data_uri: Input data URI
-        :type input_data_uri: str
-        :param provider_id: Provider ID
-        :type provider_id: str, optional
-        :param input_data_format: Input data format
-        :type input_data_format: str, optional
-        :param output_data_format: Output data format
-        :type output_data_format: str, optional
-        :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
-        :param submit_job: If job should be submitted to the service, defaults to True
-        :type submit_job: bool
-        :return: Job instance
-        :rtype: Job
-        """
-        # Generate job_id, input_params, data formats and provider ID if not specified
-        if job_id is None:
-            job_id = cls.create_job_id()
-        if input_params is None:
-            input_params = {}
-
-        # Create container for output data if not specified
-        if container_uri is None:
-            container_uri = await workspace.get_container_uri(job_id=job_id)
-
-        # Create job details and return Job
-        details = JobDetails(
-            id=job_id,
-            name=name,
-            container_uri=container_uri,
-            input_data_format=input_data_format,
-            output_data_format=output_data_format,
-            input_data_uri=input_data_uri,
-            provider_id=provider_id,
-            target=target,
-            input_params=input_params,
-            **kwargs
-        )
-        job = cls(workspace, details, **kwargs)
-
-        logger.info(
-            f"Submitting problem '{name}'. \
-                Using payload from: '{job.details.input_data_uri}'"
-        )
-
-        if submit_job:
-            logger.debug(f"==> submitting: {job.details}")
-            await job.submit()
-
-        return job
-
-    @staticmethod
-    async def upload_input_data(
-        container_uri: str,
-        input_data: bytes,
-        content_type: Optional[ContentType] = ContentType.json,
-        blob_name: str = "inputData",
-        encoding: str = "",
-        return_sas_token: bool = False
-    ) -> str:
-        """Upload input data file
-
-        :param container_uri: Container URI
-        :type container_uri: str
-        :param input_data: Input data in binary format
-        :type input_data: bytes
-        :param content_type: Content type, e.g. "application/json"
-        :type content_type: str
-        :param blob_name: Blob name, defaults to "inputData"
-        :type blob_name: str, optional
-        :param encoding: Encoding, e.g. "gzip", defaults to ""
-        :type encoding: str, optional
-        :param return_sas_token: Flag to return SAS token as part of URI, defaults to False
-        :type return_sas_token: bool, optional
-        :return: Uploaded data URI
-        :rtype: str
-        """
-        container_client = ContainerClient.from_container_url(
-            container_uri
-        )
-
-        uploaded_blob_uri = await upload_blob(
-            container_client,
-            blob_name,
-            content_type,
-            encoding,
-            input_data,
-            return_sas_token=return_sas_token
-        )
-
-        await container_client.close()
-        return uploaded_blob_uri
-
-    async def download_data(self, blob_uri: str) -> dict:
-        """Download file from blob uri
-
-        :param blob_uri: Blob URI
-        :type blob_uri: str
-        :return: Payload from blob
-        :rtype: dict
-        """
-        url = urlparse(blob_uri)
-        if url.query.find("se=") == -1:
-            # blob_uri does not contains SAS token,
-            # get sas url from service
-            blob_client = BlobClient.from_blob_url(
-                blob_uri
-            )
-            blob_uri = await self.workspace._get_linked_storage_sas_uri(
-                blob_client.container_name, blob_client.blob_name
-            )
-            payload = await download_blob(blob_uri)
-            await blob_client.close()
-        else:
-            # blob_uri contains SAS token, use it
-            payload = await download_blob(blob_uri)
-
-        return payload
-
-    async def upload_attachment(
-        self,
-        blob_name: str,
-        data: bytes,
-        container_uri: str = None,
-        **kwargs
-    ) -> str:
-        """Uploads an attachment to the job's container file. Attachment's are identified by name.
-        Uploading to an existing attachment overrides its previous content.
-
-        :param name: Attachment name
-        :type name: str
-        :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
-
-        :return: Uploaded data URI
-        :rtype: str
-        """
-
-        # Use Job's default container if not specified
-        if container_uri is None:
-            container_uri = await self.workspace.get_container_uri(job_id=self.id)
-
-        uploaded_blob_uri = await self.upload_input_data(
-            container_uri = container_uri,
-            blob_name = blob_name,
-            input_data = data,
-            **kwargs
-        )
-        return uploaded_blob_uri
-
-    async def download_attachment(
-        self,
-        name: str,
-        container_uri: str = None
-    ):
-        """ Downloads an attachment from job's container in Azure Storage. Attachments are blobs of data
-            created as part of the Job's execution, or they can be created by uploading directly from Python
-            using the upload_attachment method.
-            
-        :param name: Attachment name
-        :type name: str
-        :param container_uri: Container URI, defaults to the job's linked container.
-        :type container_uri: str, Optional
-
-        :return: Attachment data
-        :rtype: bytes
-        """
-        # Use Job's default container if not specified
-        if container_uri is None:
-            container_uri = await self.workspace.get_container_uri(job_id=self.id)
-        
-        container_client = ContainerClient.from_container_url(container_uri)
-        blob_client = container_client.get_blob_client(name)
-        response = await (await blob_client.download_blob()).readall()
-        await blob_client.close()
-
-        return response
-

azure/quantum/aio/job/job.py

@@ -1,104 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-
-import asyncio
-import logging
-import json
-import time
-
-from azure.quantum.aio.job.base_job import BaseJob, DEFAULT_TIMEOUT
-from azure.quantum.job.job import Job as SyncJob
-from azure.quantum.job.filtered_job import FilteredJob
-
-__all__ = ["Job"]
-
-logger = logging.getLogger(__name__)
-
-_log = logging.getLogger(__name__)
-
-
-class Job(BaseJob, SyncJob, FilteredJob):
-    """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
-    """
-    async def submit(self):
-        """Submit a job to Azure Quantum."""
-        _log.debug(f"Submitting job with ID {self.id}")
-        job = await self.workspace.submit_job(self)
-        self.details = job.details
-
-    async def refresh(self):
-        """Refreshes the Job's details by querying the workspace."""
-        self.details = (await self.workspace.get_job(self.id)).details
-
-    async def wait_until_completed(
-        self,
-        max_poll_wait_secs=30,
-        timeout_secs=None,
-        print_progress=True
-    ) -> None:
-        """Keeps refreshing the Job's details
-        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
-        :param timeout_secs: Timeout in seconds, defaults to None
-        :type timeout_secs: int, optional
-        :param print_progress: Print "." to stdout to display progress
-        :type print_progress: bool, optional
-        :raises TimeoutError: If the total poll time exceeds timeout, raise
-        """
-        await self.refresh()
-        poll_wait = SyncJob._default_poll_wait
-        start_time = time.time()
-        while not self.has_completed():
-            if timeout_secs is not None and (time.time() - start_time) >= timeout_secs:
-                raise TimeoutError(f"The wait time has exceeded {timeout_secs} seconds.")
-
-            logger.debug(
-                f"Waiting for job {self.id},"
-                + f"it is in status '{self.details.status}'"
-            )
-            if print_progress:
-                print(".", end="", flush=True)
-            await asyncio.sleep(poll_wait)
-            await self.refresh()
-            poll_wait = (
-                max_poll_wait_secs
-                if poll_wait >= max_poll_wait_secs
-                else poll_wait * 1.5
-            )
-
-    async def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT) -> dict:
-        """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: int
-        :raises RuntimeError: [description]
-        :return: [description]
-        :rtype: dict
-        """
-        if self.results is not None:
-            return self.results
-
-        if not self.has_completed():
-            await self.wait_until_completed(timeout_secs=timeout_secs)
-
-        if not self.details.status == "Succeeded":
-            raise RuntimeError(
-                f'{"Cannot retrieve results as job execution failed"}'
-                + f"(status: {self.details.status}."
-                + f"error: {self.details.error_data})"
-            )
-
-        payload = await self.download_data(self.details.output_data_uri)
-        results = json.loads(payload.decode("utf8"))
-        return results

azure/quantum/aio/optimization/__init__.py

@@ -1,11 +0,0 @@
-# coding=utf-8
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-
-from .problem import *
-from .online_problem import *
-from .streaming_problem import *
-from .online_problem import *
-from azure.quantum.aio.target import Solver

azure/quantum/aio/optimization/online_problem.py

@@ -1,17 +0,0 @@
-import logging
-from typing import TYPE_CHECKING
-from azure.quantum.aio.optimization import Problem
-from azure.quantum.optimization import OnlineProblem as SyncOnlineProblem
-
-logger = logging.getLogger(__name__)
-
-__all__ = ["OnlineProblem"]
-
-if TYPE_CHECKING:
-    from azure.quantum.aio.workspace import Workspace
-
-
-class OnlineProblem(SyncOnlineProblem):
-    async def download(self, workspace: "Workspace") -> Problem:
-        logger.info("The problem will be downloaded to the client")
-        return await Problem.download(self, workspace)

azure/quantum/aio/optimization/problem.py

@@ -1,102 +0,0 @@
-##
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-##
-
-from __future__ import annotations
-import logging
-from typing import TYPE_CHECKING
-
-from azure.quantum.aio.storage import (
-    ContainerClient,
-    download_blob,
-    BlobClient
-)
-from azure.quantum.aio.job.job import Job
-from azure.quantum.optimization import Problem as SyncProblem
-from azure.quantum.optimization import ProblemType
-
-logger = logging.getLogger(__name__)
-
-__all__ = ["Problem", "ProblemType"]
-
-if TYPE_CHECKING:
-    from azure.quantum.aio.workspace import Workspace
-
-
-class Problem(SyncProblem):
-    """Problem to submit to the service.
-
-    :param name: Problem name
-    :type name: str
-    :param terms: Problem terms, depending on solver.
-        Defaults to None
-    :type terms: Optional[List[Term]], optional
-    :param init_config: Optional configuration details, depending on solver.
-        Defaults to None
-    :type init_config: Optional[Dict[str,int]], optional
-    :param problem_type: Problem type (ProblemType.pubo or
-        ProblemType.ising), defaults to ProblemType.ising
-    :type problem_type: ProblemType, optional
-    """
-    async def upload(
-        self,
-        workspace: "Workspace",
-        container_name: str = "optimization-problems",
-        blob_name: str = "inputData",
-        container_uri: str = None
-    ):
-        """Uploads an optimization problem instance to
-        the cloud storage linked with the Workspace.
-
-        :param workspace: interaction terms of the problem.
-        :type workspace: Workspace
-        :param container_name: Container name, defaults to "optimization-problems"
-        :type container_name: str, optional
-        :param blob_name: Blob name, defaults to None
-        :type blob_name: str, optional
-        :param container_uri: Optional container URI
-        :type container_uri: str
-        :return: uri of the uploaded problem
-        :rtype: str
-        """
-        blob_params = [workspace, container_name, blob_name]
-        if self.uploaded_blob_uri and self.uploaded_blob_params == blob_params:
-            return self.uploaded_blob_uri
-
-        if blob_name is None:
-            blob_name = self._blob_name()
-
-        encoding = "gzip"
-        blob = self.to_blob()
-        if container_uri is None:
-            container_uri = await workspace.get_container_uri(
-                container_name=container_name
-            )
-        input_data_uri = await Job.upload_input_data(
-            input_data=blob,
-            blob_name=blob_name,
-            container_uri=container_uri,
-            encoding=encoding,
-            content_type="application/json"
-        )
-        self.uploaded_blob_params = blob_params
-        self.uploaded_blob_uri = input_data_uri
-        return input_data_uri
-
-    async def download(self, workspace: "Workspace"):
-        """Downloads the uploaded problem as an instance of `Problem`"""
-        if not self.uploaded_blob_uri:
-            raise Exception(
-                "Problem may not be downloaded before it is uploaded"
-            )
-        blob_client = BlobClient.from_blob_url(self.uploaded_blob_uri)
-        container_client = ContainerClient.from_container_url(
-            await workspace._get_linked_storage_sas_uri(
-                blob_client.container_name
-            )
-        )
-        blob_name = blob_client.blob_name
-        blob = container_client.get_blob_client(blob_name)
-        contents = await download_blob(blob.url)
-        return Problem.deserialize(contents, self.name)