desdeo 2.0.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

desdeo/problem/external/runtime.py

@@ -0,0 +1,44 @@
+"""Runtime which owns a general ProviderResolver singleton and exposes functions to manage it."""
+
+from .core import Provider, ProviderRegistry, ProviderResolver
+
+_registry = ProviderRegistry()
+_resolver = ProviderResolver(_registry)
+
+# if uri's of other type than 'desdeo://...' are to be supported, update this list
+supported_schemes = ["desdeo"]
+
+
+def get_registry() -> ProviderRegistry:
+    """Get the runtime registry."""
+    return _registry
+
+
+def get_resolver() -> ProviderResolver:
+    """Get the runtime provider resolver."""
+    return _resolver
+
+
+def register_provider(name: str, provider: Provider, *, overwrite: bool = False, clear_cache: bool = True) -> None:
+    """Register a provider to the current runtime resolver.
+
+    Args:
+        name (str): name of the provider.
+        provider (Provider): the instance of the provider.
+        overwrite (bool, optional): should an existing provider with the same
+            name be overwritten, if it already exits? Defaults to False.
+        clear_cache (bool, optional): should the resolver's cache be cleared? Defaults to True.
+
+    Raises:
+        KeyError: if overwrite is 'False' and a provider with the given `name`
+            already exists in the register of the resolver.
+    """
+    reg = get_registry()
+
+    if reg.has(name) and not overwrite:
+        raise KeyError(f"Provider {name!r} already registered")
+
+    reg.register(name, provider)
+
+    if clear_cache:
+        get_resolver().clear_caches()

desdeo/problem/gurobipy_evaluator.py

@@ -1,8 +1,8 @@
 """Defines an evaluator compatible with the Problem JSON format and transforms it into a GurobipyModel."""
 
+import warnings
 from operator import eq as _eq
 from operator import le as _le
-import warnings
 
 import gurobipy as gp
 import numpy as np
@@ -18,8 +18,7 @@ from desdeo.problem.schema import (
     TensorConstant,
     TensorVariable,
     Variable,
-    VariableTypeEnum
-
+    VariableTypeEnum,
 )
 
 
@@ -125,8 +124,16 @@ class GurobipyEvaluator:
 
             elif isinstance(var, TensorVariable):
                 # handle tensor variables, i.e., vectors etc..
-                lowerbounds = var.get_lowerbound_values() if var.lowerbounds is not None else np.full(var.shape, float("-inf")).tolist()
-                upperbounds = var.get_upperbound_values() if var.upperbounds is not None else np.full(var.shape, float("inf")).tolist()
+                lowerbounds = (
+                    var.get_lowerbound_values()
+                    if var.lowerbounds is not None
+                    else np.full(var.shape, float("-inf")).tolist()
+                )
+                upperbounds = (
+                    var.get_upperbound_values()
+                    if var.upperbounds is not None
+                    else np.full(var.shape, float("inf")).tolist()
+                )
 
                 # figure out the variable type
                 match var.variable_type:
@@ -143,13 +150,18 @@ class GurobipyEvaluator:
                         raise GurobipyEvaluatorError(msg)
 
                 # add the variable to the model
-                gvar = self.model.addMVar(shape=tuple(var.shape), lb=np.array(lowerbounds), ub=np.array(upperbounds), vtype=domain, name=var.symbol)
+                gvar = self.model.addMVar(
+                    shape=tuple(var.shape),
+                    lb=np.array(lowerbounds),
+                    ub=np.array(upperbounds),
+                    vtype=domain,
+                    name=var.symbol,
+                )
                 # set the initial value, if one has been defined
                 if var.initial_values is not None:
                     gvar.setAttr("Start", np.array(var.get_initial_values()))
                 self.mvars[var.symbol] = gvar
 
-
         # update the model before returning, so that other expressions can reference the variables
         self.model.update()
 
@@ -413,8 +425,16 @@ class GurobipyEvaluator:
                 gvar.setAttr("Start", var.initial_value)
         elif isinstance(var, TensorVariable):
             # handle tensor variables, i.e., vectors etc..
-            lowerbounds = var.get_lowerbound_values() if var.lowerbounds is not None else np.full(var.shape, float("-inf")).tolist()
-            upperbounds = var.get_upperbound_values() if var.upperbounds is not None else np.full(var.shape, float("inf")).tolist()
+            lowerbounds = (
+                var.get_lowerbound_values()
+                if var.lowerbounds is not None
+                else np.full(var.shape, float("-inf")).tolist()
+            )
+            upperbounds = (
+                var.get_upperbound_values()
+                if var.upperbounds is not None
+                else np.full(var.shape, float("inf")).tolist()
+            )
 
             # figure out the variable type
             match var.variable_type:
@@ -431,7 +451,13 @@ class GurobipyEvaluator:
                     raise GurobipyEvaluatorError(msg)
 
             # add the variable to the model
-            gvar = self.model.addMVar(shape=tuple(var.shape), lb=np.array(lowerbounds), ub=np.array(upperbounds), vtype=domain, name=var.symbol)
+            gvar = self.model.addMVar(
+                shape=tuple(var.shape),
+                lb=np.array(lowerbounds),
+                ub=np.array(upperbounds),
+                vtype=domain,
+                name=var.symbol,
+            )
             # set the initial value, if one has been defined
             if var.initial_values is not None:
                 gvar.setAttr("Start", np.array(var.get_initial_values()))
@@ -470,8 +496,7 @@ class GurobipyEvaluator:
                 expression = self.constants[name]
         return expression
 
-
-    def get_values(self) -> dict[str, float | int | bool | list[float] | list[int]]:   # noqa: C901
+    def get_values(self) -> dict[str, float | int | bool | list[float] | list[int]]:
         """Get the values from the Gurobipy Model in a dict.
 
         The keys of the dict will be the symbols defined in the problem utilized to initialize the evaluator.

desdeo/problem/infix_parser.py

@@ -20,7 +20,7 @@ from pyparsing import (
 )
 
 # Enable Packrat for better performance in recursive parsing
-ParserElement.enablePackrat(None)
+ParserElement.enable_packrat(None)
 
 
 class InfixExpressionParser:
@@ -324,18 +324,3 @@ class InfixExpressionParser:
         # simple expressions, like 'x_1', are parsed into just a string after removing any extra
         # brackets, so we add them back there in case it is needed
         return expr if isinstance(expr, list) else [expr]
-
-
-if __name__ == "__main__":
-    # Parse and convert
-    test = "(x_1 - c_2) ** 2 + x_2 ** 2 - 25"
-
-    ohh_no = "['Add', ['Negate', ['Square', ['Subtract', 'x_1', 8]]], ['Negate', ['Square', ['Add', 'x_2', 3]]], 7.7]"
-
-    to_json_parser = InfixExpressionParser(target="MathJSON")
-
-    parsed_expression = to_json_parser.parse(test)
-
-    print(f"Expresion:\n{test}")
-    print(f"Parsed:\n{to_json_parser._pre_parse(test)}")
-    print(f"MathJSON:\n{parsed_expression}")

desdeo/problem/json_parser.py

@@ -35,7 +35,7 @@ class MathParser:
     Currently only parses MathJSON to polars expressions. Pyomo WIP.
     """
 
-    def __init__(self, to_format: FormatEnum = "polars"):
+    def __init__(self, to_format: FormatEnum = "polars"):  # noqa: C901
         """Create a parser instance for parsing MathJSON notation into polars expressions.
 
         Args:
@@ -135,7 +135,7 @@ class MathParser:
                 acc = acc.to_numpy()
                 x = x.to_numpy()
 
-                if len(acc.shape) == 2 and len(x.shape) == 2:
+                if len(acc.shape) == 2 and len(x.shape) == 2:  # noqa: PLR2004
                     # Row vectors, just return the dot product, polars does not handle
                     # "column" vectors anyway
                     return pl.Series(values=np.einsum("ij,ij->i", acc, x, optimize=True))
@@ -373,7 +373,7 @@ class MathParser:
                     hasattr(x, "is_indexed")
                     and x.is_indexed()
                     and x.dim() > 0
-                    and (not hasattr(y, "is_indexed") or not y.is_indexed() or y.is_indexed() and y.dim() == 0)
+                    and (not hasattr(y, "is_indexed") or not y.is_indexed() or (y.is_indexed() and y.dim() == 0))
                 ):
                     # x is a tensor, y is scalar
                     expr = pyomo.Expression(
@@ -385,7 +385,7 @@ class MathParser:
                     hasattr(y, "is_indexed")
                     and y.is_indexed()
                     and y.dim() > 0
-                    and (not hasattr(x, "is_indexed") or not x.is_indexed() or x.is_indexed() and x.dim() == 0)
+                    and (not hasattr(x, "is_indexed") or not x.is_indexed() or (x.is_indexed() and x.dim() == 0))
                 ):
                     # y is a tensor, x is scalar
                     expr = pyomo.Expression(
@@ -534,16 +534,13 @@ class MathParser:
         def _sympy_matmul(*args):
             """Sympy matrix multiplication."""
             msg = (
-                "Matrix multiplication '@' has not been implemented for the Sympy parser yet."
-                " Feel free to contribute!"
+                "Matrix multiplication '@' has not been implemented for the Sympy parser yet. Feel free to contribute!"
             )
             raise NotImplementedError(msg)
 
         def _sympy_summation(summand):
             """Sympy matrix summation."""
-            msg = (
-                "Matrix summation 'Sum' has not been implemented for the Sympy parser yet." " Feel free to contribute!"
-            )
+            msg = "Matrix summation 'Sum' has not been implemented for the Sympy parser yet. Feel free to contribute!"
             raise NotImplementedError(msg)
 
         def _sympy_random_access(*args):
@@ -627,8 +624,7 @@ class MathParser:
 
             return _sum(summand)
             msg = (
-                "Matrix summation 'Sum' has not been implemented for the Gurobipy parser yet."
-                " Feel free to contribute!"
+                "Matrix summation 'Sum' has not been implemented for the Gurobipy parser yet. Feel free to contribute!"
             )
             raise NotImplementedError(msg)
 

desdeo/problem/pyomo_evaluator.py

@@ -3,7 +3,7 @@
 import itertools
 from collections.abc import Iterable
 from operator import eq as _eq
-from operator import le as _le
+from operator import le as _python_le
 
 import pyomo.environ as pyomo
 
@@ -19,6 +19,18 @@ from desdeo.problem.schema import (
 )
 
 
+def _le(expr, rhs, name):
+    # scalar → single constraint
+    if not expr.is_indexed():
+        tmp_expr = _python_le(expr, rhs)
+        return pyomo.Constraint(expr=tmp_expr, name=name)
+
+    # indexed → one row per index
+    tmp = pyomo.Constraint(expr.index_set(), rule=lambda m, *idx: expr[idx] <= rhs)
+    tmp.construct()
+    return tmp
+
+
 class PyomoEvaluatorError(Exception):
     """Raised when an error within the PyomoEvaluator class is encountered."""
 
@@ -159,7 +171,7 @@ class PyomoEvaluator:
                 else:
                     initial_value = (
                         var.initial_value
-                        if var.lowerbound is None and var.upperbound is None
+                        if var.lowerbound is None or var.upperbound is None
                         else (var.lowerbound + var.upperbound) / 2
                     )
 
@@ -321,16 +333,17 @@ class PyomoEvaluator:
             match con_type := cons.cons_type:
                 case ConstraintTypeEnum.LTE:
                     # constraints in DESDEO are defined such that they must be less than zero
-                    pyomo_expr = _le(pyomo_expr, 0)
+                    pyomo_expr = _le(pyomo_expr, 0, cons.name)
                 case ConstraintTypeEnum.EQ:
                     pyomo_expr = _eq(pyomo_expr, 0)
                 case _:
                     msg = f"Constraint type of {con_type} not supported. Must be one of {ConstraintTypeEnum}."
                     raise PyomoEvaluatorError(msg)
 
-            cons_expr = pyomo.Constraint(expr=pyomo_expr, name=cons.name)
+            # cons_expr = pyomo.Constraint(expr=pyomo_expr, name=cons.name)
 
-            setattr(model, cons.symbol, cons_expr)
+            setattr(model, cons.symbol, pyomo_expr)
+            # getattr(model, cons.symbol).construct()
 
         return model
 
@@ -429,9 +442,15 @@ class PyomoEvaluator:
             for extra in self.problem.extra_funcs:
                 result_dict[extra.symbol] = pyomo.value(getattr(self.model, extra.symbol))
 
+        # TODO: after implementing TensorConstraint, fix this
         if self.problem.constraints is not None:
             for const in self.problem.constraints:
-                result_dict[const.symbol] = pyomo.value(getattr(self.model, const.symbol))
+                obj = getattr(self.model, const.symbol)
+
+                if obj.is_indexed():
+                    result_dict[const.symbol] = {k: pyomo.value(obj[k]) for k in obj}
+                else:
+                    result_dict[const.symbol] = pyomo.value(obj)
 
         if self.problem.scalarization_funcs is not None:
             for scal in self.problem.scalarization_funcs:

desdeo/problem/schema.py

@@ -16,7 +16,7 @@ from collections.abc import Iterable
 from enum import Enum
 from itertools import product
 from pathlib import Path
-from typing import TYPE_CHECKING, Annotated, Any, Literal, TypeAliasType
+from typing import TYPE_CHECKING, Annotated, Any, Literal, Self
 
 import numpy as np
 from pydantic import (
@@ -61,13 +61,10 @@ def tensor_custom_error_validator(value: Any, handler: ValidatorFunctionWrapHand
         raise PydanticCustomError("invalid tensor", "Input is not a valid tensor") from exc
 
 
-Tensor = TypeAliasType(
-    "Tensor",
-    Annotated[
-        list["Tensor"] | list[VariableType] | VariableType | Literal["List"] | None,
-        WrapValidator(tensor_custom_error_validator),
-    ],
-)
+type Tensor = Annotated[
+    list["Tensor"] | list[VariableType] | VariableType | Literal["List"] | None,
+    WrapValidator(tensor_custom_error_validator),
+]
 
 
 def parse_infix_to_func(cls: "Problem", v: str | list) -> list:
@@ -260,7 +257,7 @@ class ObjectiveTypeEnum(str, Enum):
 class Constant(BaseModel):
     """Model for a constant."""
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description=(
@@ -284,7 +281,7 @@ class Constant(BaseModel):
 class TensorConstant(BaseModel):
     """Model for a tensor containing constant values."""
 
-    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True, from_attributes=True, extra="forbid")
 
     name: str = Field(description="Descriptive name of the tensor representing the values. E.g., 'distances'")
     """Descriptive name of the tensor representing the values. E.g., 'distances'"""
@@ -377,7 +374,7 @@ class TensorConstant(BaseModel):
 class Variable(BaseModel):
     """Model for a variable."""
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description="Descriptive name of the variable. This can be used in UI and visualizations. Example: 'velocity'."
@@ -407,7 +404,7 @@ class Variable(BaseModel):
 class TensorVariable(BaseModel):
     """Model for a tensor, e.g., vector variable."""
 
-    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description="Descriptive name of the variable. This can be used in UI and visualizations. Example: 'velocity'."
@@ -585,7 +582,7 @@ class ExtraFunction(BaseModel):
     they are needed for other computations related to the problem.
     """
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description=("Descriptive name of the function. Example: 'normalization'."),
@@ -663,7 +660,7 @@ class ExtraFunction(BaseModel):
 class ScalarizationFunction(BaseModel):
     """Model for scalarization of the problem."""
 
-    model_config = ConfigDict(from_attributes=True)
+    model_config = ConfigDict(from_attributes=True, extra="forbid")
 
     name: str = Field(description=("Name of the scalarization function."))
     """Name of the scalarization function."""
@@ -712,10 +709,35 @@ class ScalarizationFunction(BaseModel):
     )
 
 
+class Url(BaseModel):
+    """Model for a URL."""
+
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
+
+    url: str = Field(
+        description=(
+            "A URL to the simulator. A GET request to this URL should be used to evaluate solutions in batches."
+        )
+    )
+    """A URL to the simulator. A GET request to this URL should be used to evaluate solutions in batches."""
+
+    auth: tuple[str, str] | None = Field(
+        description=(
+            "Optional. A tuple of username and password to be used for authentication when making requests to the URL."
+        ),
+        default=None,
+    )
+    """Optional. A tuple of username and password to be used for authentication when making requests to the URL."""
+    # Add headers and stuff for a proper HTTP request if needed in the future idk
+
+
 class Simulator(BaseModel):
-    """Model for simulator data."""
+    """Model for simulator data.
+
+    One of `file` or `url` must be provided, but not both.
+    """
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description=("Descriptive name of the simulator. This can be used in UI and visualizations."),
@@ -727,10 +749,15 @@ class Simulator(BaseModel):
             " It may also be used in UIs and visualizations."
         ),
     )
-    file: Path = Field(
-        description=("Path to a python file with the connection to simulators."),
-    )
+    file: Path | None = Field(description=("Path to a python file with the connection to simulators."), default=None)
     """Path to a python file with the connection to simulators."""
+    url: Url | None = Field(
+        description=(
+            "Optional. URL to the simulator. A GET request to this URL should be used to evaluate solutions in batches."
+        ),
+        default=None,
+    )
+    """Optional. A URL to the simulator. A GET request to this URL should be used to evaluate solutions in batches."""
     parameter_options: dict | None = Field(
         description=(
             "Parameters to the simulator that are not decision variables, but affect the results."
@@ -741,12 +768,30 @@ class Simulator(BaseModel):
     """Parameters to the simulator that are not decision variables, but affect the results.
     Format is similar to decision variables. Can be 'None'."""
 
+    # Check that either file or url is provided, but not both
+    @model_validator(mode="after")
+    def check_file_or_url(self) -> Self:
+        """Ensure that either file or url is provided, but not both."""
+        if self.file is None and self.url is None:
+            raise ValueError("Either 'file' or 'url' must be provided.")
+        if self.file is not None and self.url is not None:
+            raise ValueError("Only one of 'file' or 'url' can be provided.")
+        return self
+
 
 class Objective(BaseModel):
     """Model for an objective function."""
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
+    """A longer description for the objective."""
+    description: str | None = Field(
+        description=(
+            "A longer description of the objective function. This can be used in UI and visualizations. \
+            Meant to have longer text than what name should have."
+        ),
+        default=None,
+    )
     name: str = Field(
         description=(
             "Descriptive name of the objective function. This can be used in UI and visualizations. Example: 'time'."
@@ -786,9 +831,9 @@ class Objective(BaseModel):
     variable/constant/extra function. Can be 'None' for 'data_based', 'simulator' or
     'surrogate' objective functions. If 'None', either 'simulator_path' or 'surrogates' must
     not be 'None'."""
-    simulator_path: Path | None = Field(
+    simulator_path: Path | Url | None = Field(
         description=(
-            "Path to a python file with the connection to simulators. Must be a valid Path."
+            "Path to a python file or http server with the connection to simulators. Must be a valid Path or url."
             "Can be 'None' for 'analytical', 'data_based' or 'surrogate' objective functions."
             "If 'None', either 'func' or 'surrogates' must not be 'None'."
         ),
@@ -857,7 +902,7 @@ class Objective(BaseModel):
 class Constraint(BaseModel):
     """Model for a constraint function."""
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     name: str = Field(
         description=(
@@ -903,7 +948,7 @@ class Constraint(BaseModel):
     function must match objective/variable/constant symbols.
     Can be 'None' if either 'simulator_path' or 'surrogates' is not 'None'.
     If 'None', either 'simulator_path' or 'surrogates' must not be 'None'."""
-    simulator_path: Path | None = Field(
+    simulator_path: Path | Url | None = Field(
         description=(
             "Path to a python file with the connection to simulators. Must be a valid Path."
             "Can be 'None' for if either 'func' or 'surrogates' is not 'None'."
@@ -960,7 +1005,7 @@ class DiscreteRepresentation(BaseModel):
     found at `objective_values['f_i'][j]` for all `i` and some `j`.
     """
 
-    model_config = ConfigDict(frozen=True, from_attributes=True)
+    model_config = ConfigDict(frozen=True, from_attributes=True, extra="forbid")
 
     variable_values: dict[str, list[VariableType]] = Field(
         description=(
@@ -999,7 +1044,7 @@ class DiscreteRepresentation(BaseModel):
 class Problem(BaseModel):
     """Model for a problem definition."""
 
-    model_config = ConfigDict(frozen=True)
+    model_config = ConfigDict(frozen=True, extra="forbid")
 
     _scalarization_index: int = PrivateAttr(default=1)
     # TODO: make init to communicate the _scalarization_index to a new model
@@ -1017,7 +1062,6 @@ class Problem(BaseModel):
             is_convex=db_instance.is_convex,
             is_linear=db_instance.is_linear,
             is_twice_differentiable=db_instance.is_twice_differentiable,
-            variable_domain=db_instance.variable_domain,
             scenario_keys=db_instance.scenario_keys,
             constants=constants if constants != [] else None,
             variables=[Variable.model_validate(var) for var in db_instance.variables]
@@ -1564,7 +1608,7 @@ class Problem(BaseModel):
 
         """
         json_content = self.model_dump_json(indent=4)
-        path.write_text(json_content)
+        path.write_text(json_content, encoding="utf-8")
 
     @classmethod
     def load_json(cls, path: Path) -> "Problem":
@@ -1578,33 +1622,7 @@ class Problem(BaseModel):
         """
         json_data = path.read_text()
 
-        return cls.model_validate_json(json_data)
-
-    @model_validator(mode="after")
-    def set_is_twice_differentiable(cls, values):
-        """If "is_twice_differentiable" is explicitly provided to the model, we set it to that value."""
-        if "is_twice_differentiable" in values and values["is_twice_differentiable"] is not None:
-            values["is_twice_differentiable_"] = values["is_twice_differentiable"]
-
-        return values
-
-    @model_validator(mode="after")
-    @classmethod
-    def set_is_linear(cls, values):
-        """If "is_linear" is explicitly provided to the model, we set it to that value."""
-        if "is_linear" in values and values["is_linear"] is not None:
-            values["is_linear_"] = values["is_linear"]
-
-        return values
-
-    @model_validator(mode="after")
-    @classmethod
-    def set_is_convex(cls, values):
-        """If "is_convex" is explicitly provided to the model, we set it to that value."""
-        if "is_convex" in values and values["is_convex"] is not None:
-            values["is_convex_"] = values["is_convex"]
-
-        return values
+        return cls.model_validate_json(json_data, by_name=True)
 
     name: str = Field(
         description="Name of the problem.",