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

luna_sdk/interfaces/cplex_repo_i.py

@@ -1,14 +1,14 @@
 from abc import ABC, abstractmethod
 from functools import partial
-from typing import Tuple, List
+from typing import List, Tuple
 
 import dimod
 from dimod import ConstrainedQuadraticModel
-from docplex.mp.model import Model as DOCplexModel  # type: ignore
+from dimod.constrained.constrained import CQMToBQMInverter
+from docplex.mp.model import Model as DOCplexModel
 from qiskit_optimization import QuadraticProgram
 
-from luna_sdk.interfaces import IRepository  # type: ignore
-from dimod.constrained.constrained import CQMToBQMInverter
+from luna_sdk.interfaces import IRepository
 
 
 class ICplexRepo(IRepository, ABC):
@@ -19,7 +19,7 @@ class ICplexRepo(IRepository, ABC):
         return inverter_bqm(var_sample)
 
     @abstractmethod
-    def to_qubo_qiskit(self, docplex_model: DOCplexModel) -> QuadraticProgram:
+    def to_qubo_qiskit(self, docplex_model: DOCplexModel, **kwargs) -> QuadraticProgram:
         """
         Transform DOCplex model to QUBO Qiskit
 
@@ -27,6 +27,8 @@ class ICplexRepo(IRepository, ABC):
         ----------
         docplex_model: docplex.mp.model.Model
             DOCplex problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -36,7 +38,7 @@ class ICplexRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def to_lp_file(self, docplex_model: DOCplexModel, filepath: str) -> None:
+    def to_lp_file(self, docplex_model: DOCplexModel, filepath: str, **kwargs) -> None:
         """
         Transform DOCplex to LP representation
 
@@ -46,11 +48,13 @@ class ICplexRepo(IRepository, ABC):
             DOCplex problem description
         filepath: str
             .lp file path where result should be stored
+        **kwargs
+            Parameters to pass to `httpx.request`.
         """
         raise NotImplementedError
 
     @abstractmethod
-    def to_lp_string(self, docplex_model: DOCplexModel) -> str:
+    def to_lp_string(self, docplex_model: DOCplexModel, **kwargs) -> str:
         """
         Transform DOCplex to LP representation
 
@@ -58,6 +62,9 @@ class ICplexRepo(IRepository, ABC):
         ----------
         docplex_model: docplex.mp.model.Model
             DOCplex problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         str
@@ -67,7 +74,7 @@ class ICplexRepo(IRepository, ABC):
 
     @abstractmethod
     def to_qubo_matrix(
-        self, docplex_model: DOCplexModel
+        self, docplex_model: DOCplexModel, **kwargs
     ) -> Tuple[List[List[float]], partial]:
         """
         Transform DOCplex model to QUBO matrix
@@ -76,6 +83,8 @@ class ICplexRepo(IRepository, ABC):
         ----------
         docplex_model: docplex.mp.model.Model
             DOCplex problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -86,7 +95,7 @@ class ICplexRepo(IRepository, ABC):
 
     @abstractmethod
     def to_bqm(
-        self, docplex_model: DOCplexModel
+        self, docplex_model: DOCplexModel, **kwargs
     ) -> Tuple[dimod.BinaryQuadraticModel, CQMToBQMInverter]:
         """
         Transform DOCplex model to BQM model
@@ -95,6 +104,8 @@ class ICplexRepo(IRepository, ABC):
         ----------
         docplex_model: docplex.mp.model.Model
             DOCplex problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -104,7 +115,9 @@ class ICplexRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def to_cqm(self, docplex_model: DOCplexModel) -> ConstrainedQuadraticModel:
+    def to_cqm(
+        self, docplex_model: DOCplexModel, **kwargs
+    ) -> ConstrainedQuadraticModel:
         """
         Transform DOCplex model to CQM model
 
@@ -112,6 +125,8 @@ class ICplexRepo(IRepository, ABC):
         ----------
         docplex_model: docplex.mp.model.Model
             DOCplex problem description
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------

luna_sdk/interfaces/info_repo_i.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 
 from luna_sdk.interfaces.repository_i import IRepository
 from luna_sdk.schemas.solver_info import SolverInfo
@@ -8,7 +8,7 @@ from luna_sdk.schemas.solver_info import SolverInfo
 class IInfoRepo(IRepository, ABC):
     @abstractmethod
     def solvers_available(
-        self, solver_name: Optional[str] = None
+        self, solver_name: Optional[str] = None, **kwargs
     ) -> Dict[str, Dict[str, SolverInfo]]:
         """
         Get list of available solvers.
@@ -18,6 +18,8 @@ class IInfoRepo(IRepository, ABC):
         solver_name: Optional[str]
             Name of the solver that should be retrieved. If not specified, all solvers
             will be returned.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -28,10 +30,15 @@ class IInfoRepo(IRepository, ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def providers_available(self) -> List[str]:
+    def providers_available(self, **kwargs) -> List[str]:
         """
         Get list of available providers.
 
+        Parameters
+        ----------
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         List[str]

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

@@ -5,20 +5,16 @@ 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.optimization import OptFormat
 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.solution import Numeric
 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 +22,8 @@ class IOptimizationRepo(IRepository, ABC):
         ----------
         optimization_id: str
             Id of the optimization to be retrieved.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -38,9 +36,10 @@ class IOptimizationRepo(IRepository, ABC):
     def get_all(
         self,
         timeframe: Optional[TimeframeEnum] = None,
-        input_type: Optional[InputType] = None,
+        input_type: Optional[OptFormat] = None,
         limit: int = 50,
         offset: int = 0,
+        **kwargs,
     ) -> List[Optimization]:
         """
         Retrieve a list of optimizations.
@@ -50,12 +49,14 @@ class IOptimizationRepo(IRepository, ABC):
         timeframe: Optional[TimeframeEnum]
             Only return optimizations created within a specified timeframe.
             Default None.
-        input_type: Optional[InputType]
+        input_type: Optional[OptFormat]
             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.
+        **kwargs
+            Parameters to pass to `httpx.request`.
 
         Returns
         -------
@@ -66,10 +67,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[Numeric]], **kwargs
     ) -> Optimization:
         """
         Create an optimization from a QUBO matrix.
@@ -80,10 +78,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 +90,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 +101,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 +113,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 +124,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 +136,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 +147,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 +159,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 +169,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 +181,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 +191,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 +202,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 +212,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 +223,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 +231,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,27 +13,30 @@ 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
+        Create QPU token
 
         Parameters
         ----------
         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.
+            There are two types of QPU tokens: PERSONAL and GROUP.
+            All users of a group can use group 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,9 @@ class IQpuTokenRepo(IRepository, ABC):
         filter_provider: Optional[str] = None,
         name: Optional[str] = None,
         token_type: Optional[QpuTokenTypeEnum] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        **kwargs,
     ) -> Dict[QpuTokenTypeEnum, List[QpuTokenOut]]:
         """
         Retrieve a list of QPU tokens.
@@ -58,8 +64,15 @@ class IQpuTokenRepo(IRepository, ABC):
         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
+            If you want to retrieve only user or group QPU tokens
             otherwise all QPU tokens will be retrieved
+        limit: Optional[int]
+            Number of items to fetch. Default is 10.
+        offset: Optional[int]
+            Optional. Number of items to skip. Default is 0.
+        **kwargs
+            Parameters to pass to `httpx.request`.
+
         Returns
         -------
         Dict[QpuTokenTypeEnum, List[QpuTokenOut]]
@@ -68,24 +81,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.
+            There are two types of QPU tokens: PERSONAL and GROUP.
+            All users of a group can use group 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 +108,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 QPU token by id.
 
         Parameters
         ----------
@@ -110,13 +120,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.
+            There are two types of QPU tokens: PERSONAL and GROUP.
+            All users of a group can use group 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 +135,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 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.
+            There are two types of QPU tokens: PERSONAL and GROUP.
+            All users of a group 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