luna-quantum 0.0.16__py3-none-any.whl

luna_sdk/interfaces/optimization_repo_i.py

@@ -0,0 +1,262 @@
+from abc import ABC, abstractmethod
+from io import BufferedReader
+from typing import List, Optional
+
+from dimod import BinaryQuadraticModel, ConstrainedQuadraticModel
+
+from luna_sdk.interfaces.repository_i import IRepository
+from luna_sdk.schemas.enums.optimization import InputType
+from luna_sdk.schemas.enums.timeframe import TimeframeEnum
+from luna_sdk.schemas.optimization import (
+    Optimization,
+)
+from luna_sdk.schemas.use_cases import UseCase
+
+
+class IOptimizationRepo(IRepository, ABC):
+    @abstractmethod
+    def get(
+        self,
+        optimization_id: str,
+    ) -> Optimization:
+        """
+        Retrieve a optimization by id.
+
+        Parameters
+        ----------
+        optimization_id: str
+            Id of the optimization to be retrieved.
+
+        Returns
+        -------
+        Optimization:
+            Optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_all(
+        self,
+        timeframe: Optional[TimeframeEnum] = None,
+        input_type: Optional[InputType] = None,
+        limit: int = 50,
+        offset: int = 0,
+    ) -> List[Optimization]:
+        """
+        Retrieve a list of optimizations.
+
+        Parameters
+        ----------
+        timeframe: Optional[TimeframeEnum]
+            Only return optimizations created within a specified timeframe.
+            Default None.
+        input_type: Optional[InputType]
+            Only return optimizations of a specified input type. Default None.
+        limit:
+            Limit the number of optimizations to be returned. Default value 50.
+        offset:
+            Offset the list of optimizations by this amount. Default value 0.
+
+        Returns
+        -------
+        List[Optimization]:
+            List of optimizations.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_qubo(
+        self,
+        name: str,
+        matrix: List[List[float]],
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from a QUBO matrix.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        matrix: List[List[float]]
+            QUBO matrix.
+        timeout: Optional[float]
+            Default = 10.0. Timeout for the optimization. If set to None,
+            there won't be any timeout. Increase or disable the timeout if you face
+            issues uploading big QUBO matrices.
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_use_case(
+        self,
+        name: str,
+        use_case: UseCase,
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from a use case.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        use_case: UseCase
+            Use case.
+        timeout: Optional[float]
+            Default = 10.0. Timeout for the optimization. If set to None,
+            there won't be any timeout. Increase or disable the timeout if you face
+            issues uploading big Problems.
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_bqm(
+        self,
+        name: str,
+        bqm: BinaryQuadraticModel,
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from BQM.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        bqm: BinaryQuadraticModel
+            QUBO in dimod BQM format.
+        timeout: Optional[float]
+            Default = 10.0. Timeout for the optimization. If set to None,
+            there won't be any timeout. Increase or disable the timeout if you face
+            issues uploading big Problems.
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_cqm(
+        self,
+        name: str,
+        cqm: ConstrainedQuadraticModel,
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from CQM.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        cqm: ConstrainedQuadraticModel
+            in dimod CQM format.
+        timeout: Optional[float]
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_lp_file(
+        self,
+        name: str,
+        lp_file: BufferedReader,
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from LP file.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        lp_file: buffer reader.
+        timeout: Optional[float]
+            Default = 10.0. Timeout for the optimization. If set to None,
+            there won't be any timeout. Increase or disable the timeout if you face
+            issues uploading big Problems.
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_from_lp_string(
+        self,
+        name: str,
+        lp_string: str,
+        timeout: Optional[float] = 10.0,
+    ) -> Optimization:
+        """
+        Create an optimization from LP file.
+
+        Parameters
+        ----------
+        name: str
+            Name of the optimization to be created.
+        lp_string: string.
+        timeout: Optional[float]
+            Default = 10.0. Timeout for the optimization. If set to None,
+            there won't be any timeout. Increase or disable the timeout if you face
+            issues uploading big Problems.
+
+        Returns
+        -------
+        Optimization:
+            Created optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def rename(self, optimization_id: str, name: str) -> Optimization:
+        """
+        Update the name of the optimization
+
+        Parameters
+        ----------
+        optimization_id: str
+            Id of the optimization to be updated.
+        name: str
+            New name of the optimization
+
+        Returns
+        -------
+        Optimization:
+            Updated optimization.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def delete(
+        self,
+        optimization_id: str,
+    ) -> None:
+        """
+        Delete an optimization by id.
+
+        Parameters
+        ----------
+        optimization_id: str
+            Id of the optimization to be deleted.
+        """
+        raise NotImplementedError

luna_sdk/interfaces/qpu_token_repo_i.py

@@ -0,0 +1,151 @@
+from abc import ABC, abstractmethod
+from typing import Dict, List, NoReturn, Optional
+
+from luna_sdk.interfaces.repository_i import IRepository
+from luna_sdk.schemas import QpuTokenOut
+from luna_sdk.schemas.enums.qpu_token_type import QpuTokenTypeEnum
+
+
+class IQpuTokenRepo(IRepository, ABC):
+    @abstractmethod
+    def create(
+        self,
+        name: str,
+        provider: str,
+        token: str,
+        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+        encryption_key: Optional[str] = None,
+    ) -> QpuTokenOut:
+        """
+        Create organization QPU token
+
+        Parameters
+        ----------
+        name: str
+            Name of the QPU token
+        provider: ProviderEnum
+            Name of provider
+        token: str
+            Token
+        token_type: QpuTokenTypeEnum
+            There are two types of QPU tokens: PERSONAL and ORGANIZATION.
+            The default value is PERSONAL.
+            All users of an organization can use organization QPU tokens.
+            User QPU tokens can only be used by the user who created them.
+        encryption_key: Optional[str]
+            Encryption key to be used for encryption of QPU tokens.
+        Returns
+        -------
+        QpuTokenOut
+            QpuToken instances.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_all(
+        self,
+        filter_provider: Optional[str] = None,
+        name: Optional[str] = None,
+        token_type: Optional[QpuTokenTypeEnum] = None,
+    ) -> Dict[QpuTokenTypeEnum, List[QpuTokenOut]]:
+        """
+        Retrieve a list of QPU tokens.
+
+        Parameters
+        ----------
+        filter_provider: Optional[str]
+            The provider for which qpu tokens should be retrieved
+        name: Optional[str]
+            Name of the QPU token that should be retrieved
+        token_type: Optional[QpuTokenTypeEnum]
+            If you want to retrieve only user or organization QPU tokens
+            otherwise all QPU tokens will be retrieved
+        Returns
+        -------
+        Dict[QpuTokenTypeEnum, List[QpuTokenOut]]
+            List of QpuTokenOut instances.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get(
+        self,
+        name: str,
+        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+    ) -> QpuTokenOut:
+        """
+        Retrieve user QPU token by id
+
+        Parameters
+        ----------
+        name: str
+            Name of the QPU token that should be retrieved
+
+        token_type: QpuTokenTypeEnum
+            There are two types of QPU tokens: PERSONAL and ORGANIZATION.
+            The default value is PERSONAL.
+            All users of an organization can use organization QPU tokens.
+            User QPU tokens can only be used by the user who created them.
+
+        Returns
+        -------
+        QpuTokenOut
+            QpuToken instance.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def rename(
+        self,
+        name: str,
+        new_name: str,
+        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+    ) -> QpuTokenOut:
+        """
+        Update organization QPU token by id
+
+        Parameters
+        ----------
+        name: str
+            Current name of the QPU token that should be updated
+        new_name: str
+            The new name
+
+        token_type: QpuTokenTypeEnum
+            There are two types of QPU tokens: PERSONAL and ORGANIZATION.
+            The default value is PERSONAL.
+            All users of an organization can use organization QPU tokens.
+            User QPU tokens can only be used by the user who created them.
+
+
+        Returns
+        -------
+        QpuTokenOut
+            QpuToken instance.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def delete(
+        self,
+        name: str,
+        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+    ) -> None:
+        """
+        Delete organization QPU token by id
+
+        Parameters
+        ----------
+        name: str
+            Name of the QPU token that should be deleted
+
+        token_type: QpuTokenTypeEnum
+            There are two types of QPU tokens: PERSONAL and ORGANIZATION.
+            The default value is PERSONAL.
+            All users of an organization can use organization QPU tokens.
+            User QPU tokens can only be used by the user who created them.
+
+        Returns
+        -------
+        """
+        raise NotImplementedError

luna_sdk/interfaces/repository_i.py

@@ -0,0 +1,14 @@
+from abc import ABC, abstractmethod
+from httpx import Client
+
+
+class IRepository(ABC):
+    _client: Client
+
+    def __init__(self, client: Client) -> None:
+        self._client = client
+
+    @property
+    @abstractmethod
+    def _endpoint(self) -> str:
+        raise NotImplementedError

luna_sdk/interfaces/solutions_repo_i.py

@@ -0,0 +1,219 @@
+from abc import ABC, abstractmethod
+from typing import Dict, List, Optional, Union
+
+from pydantic import BaseModel
+
+from luna_sdk.interfaces.repository_i import IRepository
+from luna_sdk.schemas.enums.timeframe import TimeframeEnum
+from luna_sdk.schemas.qpu_token import TokenProvider
+from luna_sdk.schemas.solution import (
+    Result,
+    Solution,
+    UseCaseRepresentation,
+    UseCaseResult,
+)
+
+
+class ISolutionsRepo(IRepository, ABC):
+    @abstractmethod
+    def get_all(
+        self,
+        timeframe: Optional[TimeframeEnum] = None,
+        limit: int = 50,
+        offset: int = 0,
+        optimization_id: Optional[str] = None,
+    ) -> List[Solution]:
+        """
+        Get list of available optimizations.
+
+        Parameters
+        ----------
+        timeframe: Optional[TimeframeEnum]
+            Only return Solutions created within a specified timeframe. Default None.
+        limit:
+            Limit the number of Optimizations to be returned. Default value 10.
+        offset:
+            Offset the list of solutions by this amount. Default value 0.
+        optimization_id: Optional[str]
+            Show solutions for only this optimization id. Default None.
+
+        Returns
+        -------
+        List[SolutionOut]
+            List of SolutionOut instances.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get(self, solution_id: str) -> Solution:
+        """
+        Retrieve one optimization by id.
+
+        Parameters
+        ----------
+        solution_id: str
+            Id of the solution that should be retrieved
+
+        Returns
+        -------
+        Solution
+            Solution instance
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_use_case_representation(self, solution_id: str) -> UseCaseRepresentation:
+        """
+        Get the use-case-specific representation of a solution.
+
+        Parameters
+        ----------
+        solution_id: str
+            Id of the solution that should be retrieved
+
+        Returns
+        -------
+        UseCaseRepresentation
+            The use-case-specific representation
+        """
+
+    @abstractmethod
+    def delete(self, solution_id: str) -> None:
+        """
+        Delete one optimization by id.
+
+        Parameters
+        ----------
+        solution_id: str
+            Id of the optimization that should be deleted
+
+        Returns
+        -------
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create(
+        self,
+        optimization_id: str,
+        solver_name: str,
+        provider: str,
+        qpu_tokens: Optional[TokenProvider] = None,
+        solver_parameters: Optional[Union[Dict, BaseModel]] = None,
+        encryption_key: Optional[str] = None,
+        name: Optional[str] = None,
+    ) -> Solution:
+        """
+        Create a solution for optimization
+
+        Parameters
+        ----------
+        optimization_id: str
+            The id of the optimization for which solution should be created
+        solver_name: str
+            The name of the solver to use.
+        provider: str
+            The name of the provider to use.
+        qpu_tokens: Optional[TokenProvider]
+            The tokens to be used for the QPU.
+        solver_parameters: Optional[Union[Dict, BaseModel]]
+            Parameters to be passed to the solver.
+        encryption_key: Optional[str]
+            Encryption key to be used for encryption of QPU tokens.
+        name: Optional[str]
+            Default: None, The name of the solution to create.
+
+        Returns
+        -------
+        SolutionOut
+            Returns the location where the solution can be found once solving is complete.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_blocking(
+        self,
+        optimization_id: str,
+        solver_name: str,
+        provider: str,
+        qpu_tokens: Optional[TokenProvider] = None,
+        solver_parameters: Optional[Union[Dict, BaseModel]] = None,
+        sleep_time_max: float = 60.0,
+        sleep_time_increment: float = 5.0,
+        sleep_time_initial: float = 5.0,
+        encryption_key: Optional[str] = None,
+        name: Optional[str] = None,
+    ) -> Solution:
+        """
+        Create a solution for optimization. This method will block your code until the solution is ready.
+        Depending on the problem size, this can take a long time.
+
+        Parameters
+        ----------
+        optimization_id: str
+            The id of the optimization for which solution should be created
+        solver_name: str
+            The name of the solver to use.
+        provider: str
+            The name of the provider to use.
+        qpu_tokens: Optional[TokenProvider] = None
+            The tokens to be used for the QPU.
+        solver_parameters: Optional[Union[Dict, BaseModel]]
+            Parameters to be passed to the solver.
+
+        sleep_time_max: float
+            Maximum time to sleep between requests.
+        sleep_time_increment: float
+            Increment of sleep time between requests. Initial sleep time will be
+        sleep_time_initial: float
+            Initial sleep time.
+        encryption_key: Optional[str]
+            Encryption key to be used for encryption of QPU tokens.
+        name: Optional[str]
+            Default: None, The name of the solution to create.
+        Returns
+        -------
+        SolutionOut
+            Returns the location where the solution can be found once solving is complete.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_best_result(self, solution: Solution) -> Optional[Result]:
+        """
+        Retrieves the best result from a solution.
+
+        Parameters
+        ----------
+        solution : Solution
+            The solution received via a `solutions.get` or `solutions.get_all`.
+
+        Returns
+        -------
+        Result | None
+            The best result of the solution. If there are several best solutions with
+            the same objective value, return only the first. If the solution results are
+            not (yet) available, return `None`.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_best_use_case_result(
+        self, use_case_representation: UseCaseRepresentation
+    ) -> Optional[UseCaseResult]:
+        """
+        Retrieves the best result from a solution's use case representation.
+
+        Parameters
+        ----------
+        use_case_representation : UseCaseRepresentation
+            A solution's use case representation.
+
+        Returns
+        -------
+        UseCaseResult | None
+            The best result of the solution. If there are several best solutions with
+            the same objective value, return only the first. If the solution results are
+            not (yet) available or no the solution sense is `None`, return `None`.
+        """
+        raise NotImplementedError

luna_sdk/repositories/__init__.py

@@ -0,0 +1,4 @@
+from .circuit_repo import CircuitRepo
+from .optimization_repo import OptimizationRepo
+from .qpu_token_repo import QpuTokenRepo
+from .solutions_repo import SolutionsRepo