luna-quantum 0.0.16__py3-none-any.whl → 0.0.29__py3-none-any.whl

luna_sdk/interfaces/lp_repo_i.py

@@ -1,14 +1,14 @@
 from abc import ABC, abstractmethod
 from functools import partial
-from typing import Tuple, List
+from typing import Any, Dict, List, Tuple
 
 import dimod
 from dimod import ConstrainedQuadraticModel
 from dimod.constrained.constrained import CQMToBQMInverter
-from docplex.mp.model import Model as DOCplexModel  # type: ignore
+from docplex.mp.model import Model as DOCplexModel
 from qiskit_optimization import QuadraticProgram
 
-from luna_sdk.interfaces import IRepository  # type: ignore
+from luna_sdk.interfaces import IRepository
 
 
 class ILPRepo(IRepository, ABC):
@@ -19,7 +19,7 @@ class ILPRepo(IRepository, ABC):
         return inverter_bqm(var_sample)
 
     @abstractmethod
-    def to_qubo_qiskit(self, lp_string: str) -> QuadraticProgram:
+    def to_qubo_qiskit(self, lp_string: str, **kwargs) -> QuadraticProgram:
         """
         Transform LP to QUBO Qiskit
 
@@ -27,6 +27,8 @@ class ILPRepo(IRepository, ABC):
         ----------
         lp_string: str
             LP problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -36,7 +38,7 @@ class ILPRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def to_docplex(self, lp_string: str) -> DOCplexModel:
+    def to_docplex(self, lp_string: str, **kwargs) -> DOCplexModel:
         """
         Transform LP to DOCplex
 
@@ -44,6 +46,8 @@ class ILPRepo(IRepository, ABC):
         ----------
         lp_string: str
             LP problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -53,7 +57,9 @@ class ILPRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def to_qubo_matrix(self, lp_string: str) -> Tuple[List[List[float]], partial]:
+    def to_qubo_matrix(
+        self, lp_string: str, **kwargs
+    ) -> Tuple[List[List[float]], partial]:
         """
         Transform LP to QUBO matrix
 
@@ -61,6 +67,8 @@ class ILPRepo(IRepository, ABC):
         ----------
         lp_string: str
             LP problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -71,7 +79,7 @@ class ILPRepo(IRepository, ABC):
 
     @abstractmethod
     def to_bqm(
-        self, lp_string: str
+        self, lp_string: str, **kwargs
     ) -> Tuple[dimod.BinaryQuadraticModel, CQMToBQMInverter]:
         """
         Transform LP to BQM model
@@ -80,6 +88,8 @@ class ILPRepo(IRepository, ABC):
         ----------
         lp_string: str
             LP problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -89,7 +99,7 @@ class ILPRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def to_cqm(self, lp_string: str) -> ConstrainedQuadraticModel:
+    def to_cqm(self, lp_string: str, **kwargs) -> ConstrainedQuadraticModel:
         """
         Transform LP to CQM model
 
@@ -97,6 +107,8 @@ class ILPRepo(IRepository, ABC):
         ----------
         lp_string: str
             LP problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------

luna_sdk/interfaces/optimization_repo_i.py

@@ -7,18 +7,13 @@ 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.optimization import Optimization
 from luna_sdk.schemas.use_cases import UseCase
 
 
 class IOptimizationRepo(IRepository, ABC):
     @abstractmethod
-    def get(
-        self,
-        optimization_id: str,
-    ) -> Optimization:
+    def get(self, optimization_id: str, **kwargs) -> Optimization:
         """
         Retrieve a optimization by id.
 
@@ -26,6 +21,8 @@ class IOptimizationRepo(IRepository, ABC):
         ----------
         optimization_id: str
             Id of the optimization to be retrieved.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -41,6 +38,7 @@ class IOptimizationRepo(IRepository, ABC):
         input_type: Optional[InputType] = None,
         limit: int = 50,
         offset: int = 0,
+        **kwargs,
     ) -> List[Optimization]:
         """
         Retrieve a list of optimizations.
@@ -56,6 +54,8 @@ class IOptimizationRepo(IRepository, ABC):
             Limit the number of optimizations to be returned. Default value 50.
         offset:
             Offset the list of optimizations by this amount. Default value 0.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -66,10 +66,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_qubo(
-        self,
-        name: str,
-        matrix: List[List[float]],
-        timeout: Optional[float] = 10.0,
+        self, name: str, matrix: List[List[float]], **kwargs
     ) -> Optimization:
         """
         Create an optimization from a QUBO matrix.
@@ -80,10 +77,8 @@ class IOptimizationRepo(IRepository, ABC):
             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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -94,10 +89,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_use_case(
-        self,
-        name: str,
-        use_case: UseCase,
-        timeout: Optional[float] = 10.0,
+        self, name: str, use_case: UseCase, **kwargs
     ) -> Optimization:
         """
         Create an optimization from a use case.
@@ -108,10 +100,8 @@ class IOptimizationRepo(IRepository, ABC):
             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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -122,10 +112,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_bqm(
-        self,
-        name: str,
-        bqm: BinaryQuadraticModel,
-        timeout: Optional[float] = 10.0,
+        self, name: str, bqm: BinaryQuadraticModel, **kwargs
     ) -> Optimization:
         """
         Create an optimization from BQM.
@@ -136,10 +123,8 @@ class IOptimizationRepo(IRepository, ABC):
             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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -150,10 +135,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_cqm(
-        self,
-        name: str,
-        cqm: ConstrainedQuadraticModel,
-        timeout: Optional[float] = 10.0,
+        self, name: str, cqm: ConstrainedQuadraticModel, **kwargs
     ) -> Optimization:
         """
         Create an optimization from CQM.
@@ -164,7 +146,8 @@ class IOptimizationRepo(IRepository, ABC):
             Name of the optimization to be created.
         cqm: ConstrainedQuadraticModel
             in dimod CQM format.
-        timeout: Optional[float]
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -175,10 +158,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_lp_file(
-        self,
-        name: str,
-        lp_file: BufferedReader,
-        timeout: Optional[float] = 10.0,
+        self, name: str, lp_file: BufferedReader, **kwargs
     ) -> Optimization:
         """
         Create an optimization from LP file.
@@ -188,10 +168,8 @@ class IOptimizationRepo(IRepository, ABC):
         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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -202,10 +180,7 @@ class IOptimizationRepo(IRepository, ABC):
 
     @abstractmethod
     def create_from_lp_string(
-        self,
-        name: str,
-        lp_string: str,
-        timeout: Optional[float] = 10.0,
+        self, name: str, lp_string: str, **kwargs
     ) -> Optimization:
         """
         Create an optimization from LP file.
@@ -215,10 +190,8 @@ class IOptimizationRepo(IRepository, ABC):
         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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -228,7 +201,7 @@ class IOptimizationRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def rename(self, optimization_id: str, name: str) -> Optimization:
+    def rename(self, optimization_id: str, name: str, **kwargs) -> Optimization:
         """
         Update the name of the optimization
 
@@ -238,6 +211,8 @@ class IOptimizationRepo(IRepository, ABC):
             Id of the optimization to be updated.
         name: str
             New name of the optimization
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -247,10 +222,7 @@ class IOptimizationRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def delete(
-        self,
-        optimization_id: str,
-    ) -> None:
+    def delete(self, optimization_id: str, **kwargs) -> None:
         """
         Delete an optimization by id.
 
@@ -258,5 +230,7 @@ class IOptimizationRepo(IRepository, ABC):
         ----------
         optimization_id: str
             Id of the optimization to be deleted.
+        **kwargs
+            Parameters to pass to `httpx.request`.
         """
         raise NotImplementedError

luna_sdk/interfaces/qpu_token_repo_i.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Dict, List, NoReturn, Optional
+from typing import Dict, List, Optional
 
 from luna_sdk.interfaces.repository_i import IRepository
 from luna_sdk.schemas import QpuTokenOut
@@ -13,8 +13,9 @@ class IQpuTokenRepo(IRepository, ABC):
         name: str,
         provider: str,
         token: str,
-        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+        token_type: QpuTokenTypeEnum,
         encryption_key: Optional[str] = None,
+        **kwargs,
     ) -> QpuTokenOut:
         """
         Create organization QPU token
@@ -23,17 +24,19 @@ class IQpuTokenRepo(IRepository, ABC):
         ----------
         name: str
             Name of the QPU token
-        provider: ProviderEnum
+        provider: str
             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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         QpuTokenOut
@@ -47,6 +50,7 @@ class IQpuTokenRepo(IRepository, ABC):
         filter_provider: Optional[str] = None,
         name: Optional[str] = None,
         token_type: Optional[QpuTokenTypeEnum] = None,
+        **kwargs,
     ) -> Dict[QpuTokenTypeEnum, List[QpuTokenOut]]:
         """
         Retrieve a list of QPU tokens.
@@ -60,6 +64,9 @@ class IQpuTokenRepo(IRepository, ABC):
         token_type: Optional[QpuTokenTypeEnum]
             If you want to retrieve only user or organization QPU tokens
             otherwise all QPU tokens will be retrieved
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         Dict[QpuTokenTypeEnum, List[QpuTokenOut]]
@@ -68,24 +75,20 @@ class IQpuTokenRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def get(
-        self,
-        name: str,
-        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
-    ) -> QpuTokenOut:
+    def get(self, name: str, token_type: QpuTokenTypeEnum, **kwargs) -> QpuTokenOut:
         """
-        Retrieve user QPU token by id
+        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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -99,10 +102,11 @@ class IQpuTokenRepo(IRepository, ABC):
         self,
         name: str,
         new_name: str,
-        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
+        token_type: QpuTokenTypeEnum,
+        **kwargs,
     ) -> QpuTokenOut:
         """
-        Update organization QPU token by id
+        Update organization QPU token by id.
 
         Parameters
         ----------
@@ -110,13 +114,12 @@ class IQpuTokenRepo(IRepository, ABC):
             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.
-
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -126,26 +129,19 @@ class IQpuTokenRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def delete(
-        self,
-        name: str,
-        token_type: QpuTokenTypeEnum = QpuTokenTypeEnum.PERSONAL,
-    ) -> None:
+    def delete(self, name: str, token_type: QpuTokenTypeEnum, **kwargs) -> None:
         """
-        Delete organization QPU token by id
+        Delete organization QPU token by name.
 
         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
-        -------
+        **kwargs
+            Parameters to pass to `httpx.request`.
         """
         raise NotImplementedError

luna_sdk/interfaces/solutions_repo_i.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from pydantic import BaseModel
 
@@ -22,6 +22,7 @@ class ISolutionsRepo(IRepository, ABC):
         limit: int = 50,
         offset: int = 0,
         optimization_id: Optional[str] = None,
+        **kwargs,
     ) -> List[Solution]:
         """
         Get list of available optimizations.
@@ -36,6 +37,8 @@ class ISolutionsRepo(IRepository, ABC):
             Offset the list of solutions by this amount. Default value 0.
         optimization_id: Optional[str]
             Show solutions for only this optimization id. Default None.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -45,14 +48,16 @@ class ISolutionsRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def get(self, solution_id: str) -> Solution:
+    def get(self, solution_id: str, **kwargs) -> Solution:
         """
         Retrieve one optimization by id.
 
         Parameters
         ----------
         solution_id: str
-            Id of the solution that should be retrieved
+            Id of the solution that should be retrieved.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -62,14 +67,18 @@ class ISolutionsRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def get_use_case_representation(self, solution_id: str) -> UseCaseRepresentation:
+    def get_use_case_representation(
+        self, solution_id: str, **kwargs
+    ) -> UseCaseRepresentation:
         """
         Get the use-case-specific representation of a solution.
 
         Parameters
         ----------
         solution_id: str
-            Id of the solution that should be retrieved
+            Id of the solution that should be retrieved.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -78,17 +87,16 @@ class ISolutionsRepo(IRepository, ABC):
         """
 
     @abstractmethod
-    def delete(self, solution_id: str) -> None:
+    def delete(self, solution_id: str, **kwargs) -> None:
         """
         Delete one optimization by id.
 
         Parameters
         ----------
         solution_id: str
-            Id of the optimization that should be deleted
-
-        Returns
-        -------
+            Id of the optimization that should be deleted.
+        **kwargs
+            Parameters to pass to `httpx.request`.
         """
         raise NotImplementedError
 
@@ -99,34 +107,40 @@ class ISolutionsRepo(IRepository, ABC):
         solver_name: str,
         provider: str,
         qpu_tokens: Optional[TokenProvider] = None,
-        solver_parameters: Optional[Union[Dict, BaseModel]] = None,
+        solver_parameters: Optional[Union[Dict[str, Any], BaseModel]] = None,
         encryption_key: Optional[str] = None,
         name: Optional[str] = None,
+        fail_on_invalid_params: bool = True,
+        **kwargs,
     ) -> Solution:
         """
-        Create a solution for optimization
+        Create a solution for optimization.
 
         Parameters
         ----------
         optimization_id: str
-            The id of the optimization for which solution should be created
+            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]]
+        solver_parameters: Optional[Union[Dict[str, Any], 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.
+        fail_on_invalid_params: bool
+            Default: true. Disable the local solver parameter validation.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
         SolutionOut
-            Returns the location where the solution can be found once solving is complete.
+            The location where the solution can be found once solving is complete.
         """
         raise NotImplementedError
 
@@ -137,12 +151,14 @@ class ISolutionsRepo(IRepository, ABC):
         solver_name: str,
         provider: str,
         qpu_tokens: Optional[TokenProvider] = None,
-        solver_parameters: Optional[Union[Dict, BaseModel]] = None,
+        solver_parameters: Optional[Union[Dict[str, Any], 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,
+        fail_on_invalid_params: bool = True,
+        **kwargs,
     ) -> Solution:
         """
         Create a solution for optimization. This method will block your code until the solution is ready.
@@ -151,16 +167,15 @@ class ISolutionsRepo(IRepository, ABC):
         Parameters
         ----------
         optimization_id: str
-            The id of the optimization for which solution should be created
+            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]]
+        solver_parameters: Optional[Union[Dict[str, Any], BaseModel]]
             Parameters to be passed to the solver.
-
         sleep_time_max: float
             Maximum time to sleep between requests.
         sleep_time_increment: float
@@ -171,10 +186,15 @@ class ISolutionsRepo(IRepository, ABC):
             Encryption key to be used for encryption of QPU tokens.
         name: Optional[str]
             Default: None, The name of the solution to create.
+        fail_on_invalid_params: bool
+            Default: true. Disable the local solver parameter validation.
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         SolutionOut
-            Returns the location where the solution can be found once solving is complete.
+            The location where the solution can be found once solving is complete.
         """
         raise NotImplementedError
 
@@ -186,14 +206,14 @@ class ISolutionsRepo(IRepository, ABC):
         Parameters
         ----------
         solution : Solution
-            The solution received via a `solutions.get` or `solutions.get_all`.
+            The solution received via `solutions.get` or `solutions.get_all`.
 
         Returns
         -------
-        Result | None
+        Optional[Result]
             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`.
+            not (yet) available or the solution sense is `None`, `None` is returned.
         """
         raise NotImplementedError
 
@@ -214,6 +234,6 @@ class ISolutionsRepo(IRepository, ABC):
         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`.
+            not (yet) available or the solution sense is `None`, `None` is returned.
         """
         raise NotImplementedError