luna-quantum 1.0.0__cp312-cp312-win_amd64.whl → 1.0.1rc10__cp312-cp312-win_amd64.whl

luna_quantum/algorithms/__init__.py

@@ -0,0 +1 @@
+from luna_quantum.solve.parameters.algorithms import *  # noqa: F403

luna_quantum/backends/__init__.py

@@ -0,0 +1 @@
+from luna_quantum.solve.parameters.backends import *  # noqa: F403

luna_quantum/client/rest_client/qpu_token_rest_client.py

@@ -9,7 +9,11 @@ from luna_quantum.client.interfaces.clients.qpu_token_rest_client_i import (
     IQpuTokenRestClient,
 )
 from luna_quantum.client.schemas import QpuTokenOut
-from luna_quantum.client.schemas.create import QpuTokenIn, QpuTokenTimeQuotaIn
+from luna_quantum.client.schemas.create import (
+    QpuTokenIn,
+    QpuTokenTimeQuotaIn,
+    QpuTokenTimeQuotaUpdate,
+)
 from luna_quantum.client.schemas.enums.qpu_token_type import QpuTokenTypeEnum
 from luna_quantum.client.schemas.qpu_token.qpu_token_time_quota import (
     QpuTokenTimeQuotaOut,
@@ -348,12 +352,12 @@ class QpuTokenRestClient(IQpuTokenRestClient):
             won't be updated.
             Default: None
         """
-        data = {"quota": quota, "start": start, "end": end}
+        data = QpuTokenTimeQuotaUpdate(quota=quota, start=start, end=end)
 
         endpoint = self._get_endpoint_by_type(QpuTokenTypeEnum.GROUP)
         response = self._client.patch(
             f"{endpoint}/quota/group/{qpu_token_name}",
-            content=json.dumps(data),
+            content=data.model_dump_json(),
             **kwargs,
         )
         response.raise_for_status()

luna_quantum/client/schemas/circuit.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from pydantic import BaseModel
 
-if TYPE_CHECKING:
-    from luna_quantum.client.schemas.enums.circuit import (
-        CircuitProviderEnum,
-        CircuitStatusEnum,
-    )
+from luna_quantum.client.schemas.enums.circuit import (
+    CircuitProviderEnum,
+    CircuitStatusEnum,
+)
 
 
 class CircuitJob(BaseModel):

luna_quantum/client/schemas/create/__init__.py

@@ -1,6 +1,15 @@
 from luna_quantum.client.schemas.create.circuit import CircuitIn
 from luna_quantum.client.schemas.create.qpu_token import QpuTokenIn
 from luna_quantum.client.schemas.create.qpu_token_time_quota import QpuTokenTimeQuotaIn
+from luna_quantum.client.schemas.create.qpu_token_time_quota_update import (
+    QpuTokenTimeQuotaUpdate,
+)
 from luna_quantum.client.schemas.create.qubo import QUBOIn
 
-__all__ = ["CircuitIn", "QUBOIn", "QpuTokenIn", "QpuTokenTimeQuotaIn"]
+__all__ = [
+    "CircuitIn",
+    "QUBOIn",
+    "QpuTokenIn",
+    "QpuTokenTimeQuotaIn",
+    "QpuTokenTimeQuotaUpdate",
+]

luna_quantum/client/schemas/create/circuit.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from pydantic import BaseModel
 
-if TYPE_CHECKING:
-    from luna_quantum.client.schemas.enums.circuit import CircuitProviderEnum
-    from luna_quantum.client.schemas.qpu_token.token_provider import (
-        RestAPITokenProvider,
-    )
+from luna_quantum.client.schemas.enums.circuit import CircuitProviderEnum
+from luna_quantum.client.schemas.qpu_token.token_provider import (
+    RestAPITokenProvider,
+)
 
 
 class CircuitIn(BaseModel):

luna_quantum/client/schemas/create/qpu_token.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel, ConfigDict
 
 
 class QpuTokenIn(BaseModel):
@@ -19,7 +19,4 @@ class QpuTokenIn(BaseModel):
     provider: str
     token: str
 
-    class Config:
-        """Pydantic configuration class."""
-
-        extra = Extra.forbid
+    model_config = ConfigDict(extra="forbid")

luna_quantum/client/schemas/create/qpu_token_time_quota.py

@@ -1,11 +1,8 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
-
 from pydantic import BaseModel
 
-if TYPE_CHECKING:
-    from datetime import datetime
+from luna_quantum.client.schemas.wrappers import PydanticDatetimeWrapper
 
 
 class QpuTokenTimeQuotaIn(BaseModel):
@@ -25,5 +22,5 @@ class QpuTokenTimeQuotaIn(BaseModel):
     """
 
     quota: int
-    start: datetime | None
-    end: datetime | None
+    start: PydanticDatetimeWrapper | None
+    end: PydanticDatetimeWrapper | None

luna_quantum/client/schemas/create/qpu_token_time_quota_update.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel, ConfigDict
+
+from luna_quantum.client.schemas.wrappers.datetime_wrapper import (
+    PydanticDatetimeWrapper,
+)
+
+
+class QpuTokenTimeQuotaUpdate(BaseModel):
+    """Data structure to update the time quota of a qpu token."""
+
+    quota: int | None = None
+    start: PydanticDatetimeWrapper | None = None
+    end: PydanticDatetimeWrapper | None = None
+
+    model_config = ConfigDict(extra="forbid")

luna_quantum/client/schemas/create/solve_job_create.py

@@ -5,7 +5,7 @@ from typing import Any
 from pydantic import BaseModel
 
 from luna_quantum.client.schemas.qpu_token.token_provider import (
-    RestAPITokenProvider,  # noqa: TC001
+    RestAPITokenProvider,
 )
 
 

luna_quantum/client/schemas/qpu_token/qpu_token.py

@@ -2,10 +2,10 @@ from __future__ import annotations
 
 from enum import Enum
 
-from pydantic import BaseModel, Extra, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from luna_quantum.client.schemas.enums.qpu_token_type import (
-    QpuTokenTypeEnum,  # noqa: TC001
+    QpuTokenTypeEnum,
 )
 
 
@@ -129,24 +129,21 @@ class TokenProvider(BaseModel):
     aws_secret_access_key: QpuToken | None = None
     aws_session_token: QpuToken | None = None
 
-    class Config:
-        """Pydantic configuration class."""
-
-        extra = Extra.forbid
+    model_config = ConfigDict(extra="forbid")
 
 
 class QpuTokenOut(BaseModel):
     """
-    Pydantic model for QPU token OUT.
+    pydantic model for qpu token out.
 
-    It contains the data received from the API call.
+    it contains the data received from the api call.
 
     Attributes
     ----------
-    name: Optional[str]
-        Name of the QPU token.
+    name: optional[str]
+        name of the qpu token.
     provider: str
-        Name of provider.
+        name of provider.
 
     """
 
@@ -154,8 +151,4 @@ class QpuTokenOut(BaseModel):
     provider: str
     token_type: QpuTokenTypeEnum
 
-    class Config:
-        """Pydantic configuration class."""
-
-        extra = Extra.ignore
-        from_attributes = True
+    model_config = ConfigDict(extra="forbid", from_attributes=True)

luna_quantum/client/schemas/qpu_token/token_provider.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel, ConfigDict
 
 from luna_quantum.client.schemas.qpu_token.qpu_token import (
     QpuToken,
@@ -92,6 +92,8 @@ class RestAPITokenProvider(BaseModel):
     qctrl: _RestQpuToken | None = None
     aws: AWSQpuTokens | None = None
 
+    model_config = ConfigDict(extra="forbid")
+
     @classmethod
     def from_sdk_token_provider(
         cls, token_provider: TokenProvider
@@ -128,8 +130,3 @@ class RestAPITokenProvider(BaseModel):
             qctrl=_RestQpuToken.from_qpu_token(token_provider.qctrl),
             aws=aws,
         )
-
-    class Config:
-        """Pydantic config class."""
-
-        extra = Extra.forbid

luna_quantum/errors.py

@@ -1 +1,34 @@
-from ._core.errors import *  # type: ignore[import-not-found] # noqa: F403
+"""
+Define error types for validation, failures, and runtime evaluation issues.
+
+This module defines the set of custom exception classes used throughout the system
+to handle errors related to model translation, environment management, solution
+evaluation, and sampling.
+
+The exceptions are categorized as follows:
+
+1. **Model Errors**:
+   - Raised when a model does not meet certain structural or semantic requirements,
+     such as being quadratic, unconstrained, or having the correct variable types.
+
+2. **Translation Errors**:
+   - Raised when issues occur during translation between formats, including both
+     model and solution translation failures.
+
+3. **Variable and Constraint Errors**:
+   - Raised when there are issues related to variable creation, lookup, duplication,
+     or constraint naming.
+
+4. **Environment Errors**:
+   - Raised when conflicts or inconsistencies occur in managing active environments,
+     such as having multiple active environments or none at all.
+
+5. **Sampling and Evaluation Errors**:
+   - Raised during post-processing or evaluation of samples, particularly when the
+     sample does not conform to expected formats or contains incompatible data.
+
+These error classes enable precise and meaningful error handling, helping developers
+diagnose and respond to failures consistently and effectively.
+"""
+
+from ._core.errors import *  # type: ignore[reportMissingImports] # noqa: F403

luna_quantum/errors.pyi

@@ -1,6 +1,8 @@
 class VariableOutOfRangeError(Exception):
-    """
-    Raised when a variable referenced in an expression is out of bounds for the environment.
+    """Referenced variable is out of bounds for the environment.
+
+    Raised when a variable referenced in an expression is out of bounds for the
+    environment.
 
     This error typically occurs when querying coefficients (linear, quadratic,
     or higher-order) from an `Expression` using a `Variable` whose index does not
@@ -12,6 +14,8 @@ class VariableOutOfRangeError(Exception):
         - A raw index or tuple refers to a non-existent variable ID
     """
 
+    def __str__(self, /) -> str: ...
+
 class VariableExistsError(Exception):
     """
     Raised when trying to create a variable with a name that already exists.
@@ -20,10 +24,12 @@ class VariableExistsError(Exception):
     a variable with the same name will raise this exception.
     """
 
+    def __str__(self, /) -> str: ...
+
 class VariableNotExistingError(Exception):
-    """
-    Raised when trying to get a variable with a name that does not exist.
-    """
+    """Raised when trying to get a variable with a name that does not exist."""
+
+    def __str__(self, /) -> str: ...
 
 class VariableCreationError(Exception):
     """
@@ -32,6 +38,8 @@ class VariableCreationError(Exception):
     For example, binary and spin variables cannot be created with bounds.
     """
 
+    def __str__(self, /) -> str: ...
+
 class VariablesFromDifferentEnvsError(Exception):
     """
     Raised when multiple variables from different environments are used together.
@@ -40,6 +48,8 @@ class VariablesFromDifferentEnvsError(Exception):
     `Environment`. Mixing across environments is disallowed to ensure consistency.
     """
 
+    def __str__(self, /) -> str: ...
+
 class DifferentEnvsError(Exception):
     """
     Raised when two incompatible environments are passed to a model or operation.
@@ -48,14 +58,20 @@ class DifferentEnvsError(Exception):
     or in structural operations that require consistency across multiple environments.
     """
 
+    def __str__(self, /) -> str: ...
+
 class NoActiveEnvironmentFoundError(Exception):
-    """
-    Raised when a variable or expression is created without an active environment context.
+    """Variable or Expression created without an environment (or context).
+
+    Raised when a variable or expression is created without an active environment
+    context.
 
     This typically happens when not using `with Environment(): ...` and no environment
     was explicitly provided.
     """
 
+    def __str__(self, /) -> str: ...
+
 class MultipleActiveEnvironmentsError(Exception):
     """
     Raised when multiple environments are active simultaneously.
@@ -64,6 +80,8 @@ class MultipleActiveEnvironmentsError(Exception):
     at a time. This is enforced to maintain clarity and safety.
     """
 
+    def __str__(self, /) -> str: ...
+
 class DecodeError(Exception):
     """
     Raised when decoding or deserialization of binary data fails.
@@ -72,8 +90,11 @@ class DecodeError(Exception):
     by `aqmodels.encode()`.
     """
 
+    def __str__(self, /) -> str: ...
+
 class VariableNamesError(Exception):
-    """
+    """The provided variable names are invalid.
+
     Raised when the QuboTranslator tries to create a model from a QUBO matrix, but
     the provided variable names are invalid.
 
@@ -81,15 +102,17 @@ class VariableNamesError(Exception):
     the number of names has to match the number of variables in the QUBO matrix.
     """
 
+    def __str__(self, /) -> str: ...
+
 class IllegalConstraintNameError(Exception):
-    """
-    Raised when a constraint is tried to be created with an illegal name.
-    """
+    """Raised when a constraint is tried to be created with an illegal name."""
+
+    def __str__(self, /) -> str: ...
 
 class TranslationError(Exception):
-    """
-    Raised when an error occurred during translation.
-    """
+    """Raised when an error occurred during translation."""
+
+    def __str__(self, /) -> str: ...
 
 class ModelNotQuadraticError(TranslationError):
     """
@@ -99,16 +122,23 @@ class ModelNotQuadraticError(TranslationError):
     expressions. This error signals that unsupported terms were detected.
     """
 
+    def __str__(self, /) -> str: ...
+
 class ModelNotUnconstrainedError(TranslationError):
-    """
-    Raised when an operation requires an unconstrained model, but constraints are present.
+    """Operation requires an unconstrained model.
+
+    Raised when an operation requires an unconstrained model, but constraints are
+    present.
 
     Some solution methods may only work on unconstrained models, such as when
     transforming a symbolic model to a low-level format.
     """
 
+    def __str__(self, /) -> str: ...
+
 class ModelSenseNotMinimizeError(TranslationError):
-    """
+    """Operation requires a model for minimization.
+
     Raised when an operation requires a model with minimization sense, but has
     maximization sense.
 
@@ -117,8 +147,11 @@ class ModelSenseNotMinimizeError(TranslationError):
     objective by `-1` if necessary.
     """
 
+    def __str__(self, /) -> str: ...
+
 class ModelVtypeError(TranslationError):
-    """
+    """Operation has constraints on model's variable types.
+
     Raised when an operation has certain constraints on a model's variable types that
     are violated.
 
@@ -126,6 +159,8 @@ class ModelVtypeError(TranslationError):
     type, or where only certain variable types are permitted.
     """
 
+    def __str__(self, /) -> str: ...
+
 class SolutionTranslationError(Exception):
     """
     Raised when something goes wrong during the translation of a solution.
@@ -135,6 +170,8 @@ class SolutionTranslationError(Exception):
     consistent with the model the solution is created for.
     """
 
+    def __str__(self, /) -> str: ...
+
 class SampleIncorrectLengthError(SolutionTranslationError):
     """
     Raised when a sample length is different from the number of model variables.
@@ -144,8 +181,11 @@ class SampleIncorrectLengthError(SolutionTranslationError):
     variables in the model environment that is passed to the translator.
     """
 
+    def __str__(self, /) -> str: ...
+
 class SampleUnexpectedVariableError(SolutionTranslationError):
-    """
+    """Variable not present in environment.
+
     Raised when a sample contains a variable with a name that is not present in the
     environment.
 
@@ -153,8 +193,11 @@ class SampleUnexpectedVariableError(SolutionTranslationError):
     contain the same variables as the sample.
     """
 
+    def __str__(self, /) -> str: ...
+
 class SampleIncompatibleVtypeError(SolutionTranslationError):
-    """
+    """A sample's assignments have incompatible vtypes.
+
     Raised when a sample's assignments have variable types incompatible with the
     model's variable types.
 
@@ -166,20 +209,34 @@ class SampleIncompatibleVtypeError(SolutionTranslationError):
     conversions of variables outside the permitted range will fail.
     """
 
+    def __str__(self, /) -> str: ...
+
 class ComputationError(Exception):
-    """
-    Raised when an error occured in an internal computation.
-    """
+    """Raised when an error occured in an internal computation."""
+
+    def __str__(self, /) -> str: ...
 
 class EvaluationError(Exception):
-    """
-    Raised when an error occured during evaluation of a model.
-    """
+    """Raised when an error occured during evaluation of a model."""
+
+    def __str__(self, /) -> str: ...
+
+class DuplicateConstraintNameError(Exception):
+    """Raised when a duplicate constraint name is used."""
+
+    def __str__(self, /) -> str: ...
+
+class CompilationError(Exception):
+    """Raised when an error occured during compilation of a model in the PassManager."""
+
+    def __str__(self, /) -> str: ...
 
 __all__ = [
+    "ComputationError",
     "ComputationError",
     "DecodeError",
     "DifferentEnvsError",
+    "DuplicateConstraintNameError",
     "EvaluationError",
     "IllegalConstraintNameError",
     "ModelNotQuadraticError",

luna_quantum/solve/domain/solve_job.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 from logging import Logger
 from typing import ClassVar, Literal
 
@@ -10,6 +9,7 @@ from luna_quantum.client.interfaces.services.luna_solve_i import ILunaSolve
 from luna_quantum.client.schemas.enums.call_style import CallStyle
 from luna_quantum.client.schemas.enums.model_format import ModelFormat
 from luna_quantum.client.schemas.enums.status import StatusEnum
+from luna_quantum.client.schemas.wrappers import PydanticDatetimeWrapper
 from luna_quantum.factories.luna_solve_client_factory import LunaSolveClientFactory
 from luna_quantum.util.log_utils import Logging
 
@@ -20,7 +20,7 @@ class SolveJob(BaseModel):
     _logger: ClassVar[Logger] = Logging.get_logger(__name__)
     id: str
     status: StatusEnum
-    status_timeline: dict[StatusEnum, datetime]
+    status_timeline: dict[StatusEnum, PydanticDatetimeWrapper]
     error_message: str | None = None
     solver_job_info: str | None = None
     used_format: ModelFormat | None = None

luna_quantum/solve/parameters/algorithms/base_params/quantum_annealing_params.py

@@ -69,6 +69,7 @@ class QuantumAnnealingParams(BaseModel):
     flux_biases: list[float] | None = None
     flux_drift_compensation: bool = True
     h_gain_schedule: list[tuple[float, float]] | None = None
+
     initial_state: list[int] | None = None
     max_answers: int | None = Field(default=None, ge=1)
     num_reads: int = Field(default=1, ge=1)

luna_quantum/solve/parameters/algorithms/base_params/scipy_optimizer.py

@@ -41,14 +41,16 @@ ScipyOptimizerMethod = Literal[
 class ScipyOptimizerParams(BaseModel):
     """Wrapper for scipy.optimize.minimize.
 
-    See https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
+    See [SciPy minimize documentation](
+    https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
     for more information of the available methods and parameters.
 
     Attributes
     ----------
     method: ScipyOptimizerMethod
         Type of solver. See
-        https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
+        [SciPy minimize documentation](
+        https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
         for supported methods.
     tol: float | None
         Tolerance for termination.

luna_quantum/solve/parameters/algorithms/quantum_annealing/quantum_annealing.py

@@ -26,37 +26,53 @@ class QuantumAnnealing(QuantumAnnealingParams, LunaAlgorithm[DWaveQpu]):
 
     Attributes
     ----------
-    anneal_offsets: Any | None
-        Per-qubit time offsets for the annealing path. Default is None.
-    anneal_schedule: Any | None
-        Custom schedule for the annealing process. Default is None.
-    annealing_time: Any | None
-        Duration of the annealing process in microseconds. Default is None.
-    auto_scale: Any | None
-        Whether to automatically normalize the problem energy range.
+    anneal_offsets: list[float] | None
+        Per-qubit time offsets for the annealing path in normalized annealing time
+        units. List of floats with length equal to the number of qubits. Default is
+        None.
+    anneal_schedule: list[tuple[float, float]] | None
+        Custom schedule for the annealing process as a list of (time, s) pairs.
+        Time is in normalized units [0, 1] and s is the annealing parameter [0, 1].
         Default is None.
+    annealing_time: float | None
+        Duration of the annealing process in microseconds. Must be within the range
+        supported by the QPU hardware. Default is None.
+    auto_scale: bool | None
+        Whether to automatically normalize the problem energy range to use the full
+        range of h and J values supported by the hardware. Default is None.
     fast_anneal: bool
-        Use accelerated annealing protocol. Default is False.
-    flux_biases: Any | None
-        Custom flux bias offsets for each qubit. Default is None.
+        Use accelerated annealing protocol for shorter annealing times. Default is
+        False.
+    flux_biases: list[float] | None
+        Custom flux bias offsets for each qubit in units of Φ₀ (flux quantum).
+        List length must equal the number of qubits. Default is None.
     flux_drift_compensation: bool
-        Whether to compensate for drift in qubit flux over time. Default is True.
-    h_gain_schedule: Any | None
-        Schedule for h-gain during annealing. Default is None.
-    initial_state: Any | None
-        Starting state for the annealing process. Default is None.
+        Whether to compensate for drift in qubit flux over time using real-time
+        calibration data. Default is True.
+    h_gain_schedule: list[tuple[float, float]] | None
+        Schedule for h-gain during annealing as a list of (time, gain) pairs.
+        Time is in normalized units [0, 1]. Default is None.
+    initial_state: list[int] | None
+        Starting state for the annealing process. List of {-1, +1} values with
+        length equal to the number of qubits. Default is None.
     max_answers: int | None
-        Maximum number of unique answer states to return. Default is None.
+        Maximum number of unique answer states to return. Must be ≤ num_reads.
+        Default is None.
     num_reads: int
-        Number of annealing cycles to perform. Default is 1.
+        Number of annealing cycles to perform. Must be positive integer.
+        Default is 1.
     programming_thermalization: float | None
-        Wait time after programming the QPU. Default is None.
+        Wait time after programming the QPU in microseconds to allow the system
+        to thermalize. Default is None.
     readout_thermalization: float | None
-        Wait time after each anneal before reading results. Default is None.
+        Wait time after each anneal before reading results in microseconds.
+        Default is None.
     reduce_intersample_correlation: bool
-        Whether to add delay between samples. Default is False.
+        Whether to add delay between samples to reduce correlation between
+        consecutive measurements. Default is False.
     reinitialize_state: bool | None
-        Whether to reset to a new initial state between reads. Default is None.
+        Whether to reset to a new initial state between reads to reduce correlation.
+        Default is None.
     """
 
     @property

luna_quantum/solve/parameters/algorithms/quantum_gate/flex_qaoa/optimizers.py

@@ -14,14 +14,16 @@ class LinearOptimizerParams(ScipyOptimizerParams):
     ScipyOptimizer.
 
     Wrapper for scipy.optimize.minimize. See
-    https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
+    [SciPy minimize documentation](
+    https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
     for more information of the available methods and parameters.
 
     Attributes
     ----------
     method: ScipyOptimizerMethod
         Type of solver. See
-        https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
+        [SciPy minimize documentation](
+        https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
         for supported methods.
     tol: float | None
         Tolerance for termination.