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

luna_quantum/translator.pyi

@@ -17,8 +17,8 @@ class ZibTranslator:
 
         - Convert a Zib-style solution into our solution `Solution`.
 
-    The conversions are especially required when interacting with external zib solvers/samplers or
-    libraries that operate on zib-based problem-solving/sampling.
+    The conversions are especially required when interacting with external zib
+    solvers/samplers or libraries that operate on zib-based problem-solving/sampling.
 
     Examples
     --------
@@ -63,8 +63,8 @@ class ZibTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-                two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -72,10 +72,13 @@ class ZibTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 class Qubo:
-    """
-    A wrapper around qubo matrices that holds all relevant metadata, e.g., the model offset.
+    """The result of the QuboTranslator.
+
+    A wrapper around qubo matrices that holds all relevant metadata,
+    e.g., the model offset.
     """
 
     @property
@@ -89,6 +92,7 @@ class Qubo:
             A square NumPy array representing the QUBO matrix derived from
             the model's objective.
         """
+        ...
 
     @property
     def variable_names(self, /) -> list[str]:
@@ -100,6 +104,7 @@ class Qubo:
         list[Variable]
             The variable names in the order they appear in the QUBO.
         """
+        ...
 
     @property
     def name(self, /) -> str:
@@ -111,6 +116,7 @@ class Qubo:
         str
             The model name.
         """
+        ...
 
     @property
     def offset(self, /) -> float:
@@ -122,6 +128,7 @@ class Qubo:
         float
             The constant offset of the model.
         """
+        ...
 
     @property
     def vtype(self, /) -> Vtype:
@@ -133,6 +140,7 @@ class Qubo:
         Vtype
             The variable type.
         """
+        ...
 
 class QuboTranslator:
     """
@@ -148,7 +156,7 @@ class QuboTranslator:
     Examples
     --------
     >>> import numpy as np
-    >>> from luna_quantum import QuboTranslator, Vtype
+    >>> from luna_quantum.translator import QuboTranslator, Vtype
     >>> q = np.array([[1.0, -1.0], [-1.0, 2.0]])
 
     Create a model from a matrix:
@@ -200,6 +208,7 @@ class QuboTranslator:
             If a list of variable names is provided but contains duplicates or has an
             incorrect length.
         """
+        ...
 
     @staticmethod
     def from_aq(model: Model) -> Qubo:
@@ -215,9 +224,10 @@ class QuboTranslator:
         Returns
         -------
         Qubo
-            An object representing a QUBO with information additional to the square NumPy array
-            representing the QUBO matrix derived from the model's objective. This object also
-            includes the `variable_ordering` as well as the `offset` of the original model.
+            An object representing a QUBO with information additional to the square
+            NumPy array representing the QUBO matrix derived from the model's objective.
+            This object also includes the `variable_ordering` as well as the `offset`
+            of the original model.
 
         Raises
         ------
@@ -234,6 +244,7 @@ class QuboTranslator:
             If the model contains different vtypes or vtypes other than binary and
             spin.
         """
+        ...
 
 class QctrlTranslator:
     """
@@ -242,8 +253,8 @@ class QctrlTranslator:
     `QctrlTranslator` provides methods to:
     - Convert a Qctrl-style solution into our solution `Solution`.
 
-    The conversions are especially required when interacting with external qctrl solvers/samplers or
-    libraries that operate on qctrl-based problem-solving/sampling.
+    The conversions are especially required when interacting with external qctrl
+    solvers/samplers or libraries that operate on qctrl-based problem-solving/sampling.
 
     Examples
     --------
@@ -291,8 +302,8 @@ class QctrlTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-            two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -300,11 +311,13 @@ class QctrlTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 class NumpyTranslator:
-    """
-    Utility class for converting between a result consisting of numpy arrays and our solution
-    format.
+    """Translate between numpy arrays and our solution format.
+
+    Utility class for converting between a result consisting of numpy arrays and our
+    solution format.
 
     `NumpyTranslator` provides methods to:
     - Convert a numpy-array result into our solution `Solution`.
@@ -340,8 +353,9 @@ class NumpyTranslator:
         *,
         env: Environment | None = ...,
     ) -> Solution:
-        """
-        Convert an IBM solution to our solution format.
+        """Convert a solution in the format of numpy arrays to our solution format.
+
+        Note that the optimization sense is always assumed to be minimization.
 
         Parameters
         ----------
@@ -359,8 +373,8 @@ class NumpyTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-                two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -368,6 +382,7 @@ class NumpyTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 class LpTranslator:
     """
@@ -383,7 +398,7 @@ class LpTranslator:
     Examples
     --------
     >>> from pathlib import Path
-    >>> from luna_quantum import LpTranslator
+    >>> from luna_quantum.translator import LpTranslator
     >>> lp_filepath = Path("path/to/the/lp_file")
 
     >>> model = LpTranslator.to_aq(lp_filepath)
@@ -398,7 +413,9 @@ class LpTranslator:
     def to_aq(file: Path) -> Model: ...
     @overload
     @staticmethod
-    def to_aq(file: str) -> Model:
+    def to_aq(file: str) -> Model: ...
+    @staticmethod
+    def to_aq(file: str | Path) -> Model:
         """
         Convert an LP file into a symbolic `Model`.
 
@@ -422,13 +439,16 @@ class LpTranslator:
         TranslationError
             If the translation fails for a different reason.
         """
+        ...
 
     @overload
     @staticmethod
     def from_aq(model: Model) -> str: ...
     @overload
     @staticmethod
-    def from_aq(model: Model, *, filepath: Path) -> None:
+    def from_aq(model: Model, *, filepath: Path) -> None: ...
+    @staticmethod
+    def from_aq(model: Model, *, filepath: Path | None = ...) -> None:
         """
         Convert a symbolic model to an LP file representation.
 
@@ -449,16 +469,16 @@ class LpTranslator:
         TranslationError
             If the translation fails for some reason.
         """
+        ...
 
 class IbmTranslator:
-    """
-    Utility class for converting between an IBM solution and our solution format.
+    """Utility class for converting between an IBM solution and our solution format.
 
     `IbmTranslator` provides methods to:
     - Convert an IBM-style solution into our solution `Solution`.
 
-    The conversions are especially required when interacting with external ibm solvers/samplers or
-    libraries that operate on ibm-based problem-solving/sampling.
+    The conversions are especially required when interacting with external ibm
+    solvers/samplers oe libraries that operate on ibm-based problem-solving/sampling.
 
     Examples
     --------
@@ -524,8 +544,8 @@ class IbmTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-                two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -533,16 +553,17 @@ class IbmTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 class DwaveTranslator:
-    """
-    Utility class for converting between a DWAVE solution and our solution format.
+    """Utility class for converting between a DWAVE solution and our solution format.
 
     `DWaveSolutionTranslator` provides methods to:
     - Convert a dimod-style solution into our solution `Solution`.
 
     The conversions are especially required when interacting with external dwave/dimod
-    solvers/samplers or libraries that operate on dwave/dimod-based problem-solving/sampling.
+    solvers/samplers or libraries that operate on dwave/dimod-based problem-solving/
+    sampling.
 
     Examples
     --------
@@ -590,8 +611,8 @@ class DwaveTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-                two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -599,9 +620,11 @@ class DwaveTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 class CqmTranslator:
-    """
+    """CQM to AQM translator.
+
     Utility class for converting between dimod.BinaryQuadraticModel (CQM) and symbolic
     models.
 
@@ -616,7 +639,7 @@ class CqmTranslator:
     --------
     >>> import dimod
     >>> import numpy as np
-    >>> from luna_quantum import CqmTranslator, Vtype
+    >>> from luna_quantum.translator import CqmTranslator, Vtype
     >>> bqm = dimod.generators.gnm_random_bqm(5, 10, "BINARY")
 
     Create a model from a matrix:
@@ -650,6 +673,8 @@ class CqmTranslator:
         TranslationError
             If the translation fails for some reason.
         """
+        ...
+
     @staticmethod
     def from_aq(model: Model) -> ConstrainedQuadraticModel:
         """
@@ -671,9 +696,11 @@ class CqmTranslator:
         TranslationError
             If the translation fails for some reason.
         """
+        ...
 
 class BqmTranslator:
-    """
+    """BQM to AQM translator.
+
     Utility class for converting between dimod.BinaryQuadraticModel (BQM) and symbolic
     models.
 
@@ -688,7 +715,7 @@ class BqmTranslator:
     --------
     >>> import dimod
     >>> import numpy as np
-    >>> from luna_quantum import BqmTranslator, Vtype
+    >>> from luna_quantum.translator import BqmTranslator, Vtype
     >>> bqm = dimod.generators.gnm_random_bqm(5, 10, "BINARY")
 
     Create a model from a matrix:
@@ -705,7 +732,9 @@ class BqmTranslator:
     def to_aq(bqm: BinaryQuadraticModel) -> Model: ...
     @overload
     @staticmethod
-    def to_aq(bqm: BinaryQuadraticModel, *, name: str) -> Model:
+    def to_aq(bqm: BinaryQuadraticModel, *, name: str) -> Model: ...
+    @staticmethod
+    def to_aq(bqm: BinaryQuadraticModel, *, name: str | None = ...) -> Model:
         """
         Convert a BQM into a symbolic `Model`.
 
@@ -721,6 +750,8 @@ class BqmTranslator:
         Model
             A symbolic model representing the given BQM.
         """
+        ...
+
     @staticmethod
     def from_aq(model: Model) -> BinaryQuadraticModel:
         """
@@ -752,6 +783,7 @@ class BqmTranslator:
             If the model contains different vtypes or vtypes other than binary and
             spin.
         """
+        ...
 
 class AwsTranslator:
     """
@@ -760,8 +792,8 @@ class AwsTranslator:
     `AwsTranslator` provides methods to:
     - Convert an AWS-style result into our solution `Solution`.
 
-    The conversions are especially required when interacting with external aws solvers/samplers or
-    libraries that operate on aws-based problem-solving/sampling.
+    The conversions are especially required when interacting with external aws
+    solvers/samplers or libraries that operate on aws-based problem-solving/sampling.
 
     Examples
     --------
@@ -808,8 +840,8 @@ class AwsTranslator:
         NoActiveEnvironmentFoundError
             If no environment is passed to the method or available from the context.
         SolutionTranslationError
-            Generally if the solution translation fails. Might be specified by one of the
-            two following errors.
+            Generally if the solution translation fails. Might be specified by one of
+            the two following errors.
         SampleIncorrectLengthError
             If a solution's sample has a different number of variables than the model
             environment passed to the translator.
@@ -817,6 +849,7 @@ class AwsTranslator:
             If the result's variable types are incompatible with the model environment's
             variable types.
         """
+        ...
 
 __all__ = [
     "AwsTranslator",

luna_quantum/util/debug_info.py

@@ -0,0 +1,52 @@
+import platform
+import sys
+from logging import Logger
+
+from rich import box
+from rich.table import Table
+
+from luna_quantum._core import __aq_model_version__, __luna_quantum_version__
+from luna_quantum.util.log_utils import Logging
+
+_logger: Logger = Logging.get_logger(__name__)
+_pkg_list: list[str] = ["numpy", "pydantic"]
+
+
+def debug_info() -> None:
+    """Print debug information."""
+    python_version = (
+        f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+    )
+    os_info = f"{platform.system()} {platform.release()}"
+
+    # Get additional system information
+    architecture = platform.machine()
+    python_implementation = platform.python_implementation()
+
+    table = Table(
+        title="Luna Debug Information",
+        title_justify="left",
+        caption="System and environment details for troubleshooting",
+        box=box.MARKDOWN,
+    )
+    table.add_column("Property", style="cyan", no_wrap=True)
+    table.add_column("Version", style="green", no_wrap=True)
+
+    # Add rows to the table
+    table.add_row("Luna Quantum", f"{__luna_quantum_version__}")
+    table.add_row("AqModel", f"{__aq_model_version__}")
+    table.add_row("Python", f"{python_version}")
+    table.add_row("Python Implementation", f"{python_implementation}")
+    table.add_row("Operating System", f"{os_info}")
+    table.add_row("Architecture", f"{architecture}")
+
+    for package in _pkg_list:
+        try:
+            module = __import__(package)
+            version = getattr(module, "__version__", "pkg found, version unknown")
+            table.add_row(package, version)
+        except ImportError:
+            table.add_row(package, "pkg not found")
+
+    # Print the table to console
+    Logging.get_console().print(table)

luna_quantum/util/log_utils.py

@@ -56,6 +56,20 @@ class Logging:
         """
         return Logging._log_level
 
+    @staticmethod
+    def get_console() -> Console:
+        """Return a Rich console instance for use in logging."""
+        custom_theme = Theme(
+            {
+                "logging.level.debug": "bright_blue",
+                "logging.level.info": "bright_green",
+                "logging.level.warning": "bold bright_yellow",
+                "logging.level.error": "bold bright_red",
+                "logging.level.critical": "bold bright_magenta",
+            }
+        )
+        return Console(theme=custom_theme)
+
     @staticmethod
     def get_logger(name: str) -> logging.Logger:
         """Get a logger with the specified name and set up a RichHandler for it.
@@ -77,18 +91,8 @@ class Logging:
         if logger.hasHandlers():
             return logger
 
-        custom_theme = Theme(
-            {
-                "logging.level.debug": "bright_blue",
-                "logging.level.info": "bright_green",
-                "logging.level.warning": "bold bright_yellow",
-                "logging.level.error": "bold bright_red",
-                "logging.level.critical": "bold bright_magenta",
-            }
-        )
-        console = Console(theme=custom_theme)
         handler = RichHandler(
-            console=console,
+            console=Logging.get_console(),
             rich_tracebacks=True,
             show_time=True,
             show_level=True,

luna_quantum/utils.py

@@ -1,54 +1,3 @@
-from collections.abc import Iterable
+"""Utility module containing convenience functions."""
 
-from ._core import Expression, Variable
-
-
-def quicksum(
-    iterable: Iterable[Expression | Variable | int | float],
-    /,
-    start: Expression | None = None,
-) -> Expression:
-    """
-    Create an Expression based on an iterable of Expression, Variable, int or float elements.
-    Note that either the `iterable` must contain at least one `Expression` or `Variable` or
-    the start parameter is set.
-
-    Parameters
-    ----------
-    iterable : Iterable[Expression | Variable | int | float]
-        The iterable of elements to sum up.
-    start : Expression | None, optional
-        The starting value for the summation.
-
-    Returns
-    -------
-    Expression
-        The expression created based on the sum of the iterable elements.
-
-    Raises
-    ------
-    TypeError
-        If the `iterable` does not contain any Expression or Variable.
-        If the `start` is not of type Expression.
-    """
-    items = list(iterable)
-    if start is None:
-        for item in items:
-            if isinstance(item, Expression) or isinstance(item, Variable):
-                start = Expression(env=item._environment)  # type: ignore
-                break
-
-    if start is None:
-        raise TypeError(
-            "iterable must contain at least one Expression or Variable,or 'start' needs to be set."
-        )
-
-    if not isinstance(start, Expression):
-        raise TypeError("start must be of type `Expression`")
-
-    _start: Expression = start
-
-    for item in items:
-        _start += item
-
-    return _start
+from ._core.utils import *  # type: ignore[reportMissingImports] # noqa: F403

luna_quantum/utils.pyi

@@ -1,8 +1,38 @@
-from collections.abc import Iterable
+from collections.abc import Generator, Iterable
 from typing import overload
 
 from aqmodels import Expression, Variable
 
+@overload
+def quicksum(iterable: Generator[Expression], /) -> Expression: ...
+@overload
+def quicksum(iterable: Generator[Variable], /) -> Expression: ...
+@overload
+def quicksum(iterable: Generator[int], /) -> Expression: ...
+@overload
+def quicksum(iterable: Generator[float], /) -> Expression: ...
+@overload
+def quicksum(
+    iterable: Generator[Expression], /, start: Expression | None = None
+) -> Expression: ...
+@overload
+def quicksum(
+    iterable: Generator[Variable], /, start: Expression | None = None
+) -> Expression: ...
+@overload
+def quicksum(
+    iterable: Generator[int], /, start: Expression | None = None
+) -> Expression: ...
+@overload
+def quicksum(
+    iterable: Generator[float], /, start: Expression | None = None
+) -> Expression: ...
+@overload
+def quicksum(
+    iterable: Generator[Expression | Variable | float | int],
+    /,
+    start: Expression | None = None,
+) -> Expression: ...
 @overload
 def quicksum(iterable: Iterable[Expression], /) -> Expression: ...
 @overload
@@ -33,3 +63,5 @@ def quicksum(
     /,
     start: Expression | None = None,
 ) -> Expression: ...
+
+__all__ = ["quicksum"]

{luna_quantum-1.0.0.dist-info → luna_quantum-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luna-quantum
-Version: 1.0.0
+Version: 1.0.1
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -10,15 +10,13 @@ Requires-Dist: numpy>=1
 Requires-Dist: pydantic[email]>=2.11.3,<3
 Requires-Dist: python-dateutil>=2.9.0,<3
 Requires-Dist: rich>=14.0.0
-Requires-Dist: networkx>=3.4.2,<4 ; extra == 'examples'
-Provides-Extra: examples
 License-File: LICENSE
 License-File: NOTICE
 Summary: Python SDK for Aqarios' Luna Platform
 Keywords: aqarios,luna,quantum computing,quantum optimization,optimization,sdk
 Author-email: Aqarios <pypi@aqarios.com>
 License: Apache-2.0
-Requires-Python: >=3.11.0, <4
+Requires-Python: >=3.11.0, <3.14
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Homepage, https://aqarios.com/
 Project-URL: Documentation, https://docs.aqarios.com/