aegis_sim.parameterization.parameter

  1import logging
  2
  3
  4class Parameter:
  5    def __init__(
  6        self,
  7        key,
  8        name,
  9        domain,
 10        default,
 11        info,
 12        dtype,
 13        drange,
 14        info_extended=None,
 15        inrange=lambda x: True,
 16        serverrange=lambda x: True,
 17        serverrange_info="",
 18        evalrange=None,
 19        presets={},
 20        show_in_docs=True,
 21        show_in_gui=True,
 22        previous_keys=[],
 23    ):
 24        self.key = key
 25        self.name = name
 26        self.domain = domain
 27        self.default = default
 28        self.info = info
 29        self.info_extended = info_extended
 30        self.dtype = dtype
 31        self.drange = drange
 32        self.inrange = inrange
 33        self.serverrange = serverrange
 34        self.serverrange_info = serverrange_info
 35        self.evalrange = evalrange
 36        self.presets = presets
 37        self.show_in_docs = show_in_docs
 38        self.show_in_gui = show_in_gui
 39        self.previous_keys = previous_keys
 40
 41    def convert(self, value):
 42        if value is None or value == "":
 43            return self.default
 44        elif self.dtype == bool:
 45            return value in ("True", "true", True)
 46        else:
 47            return self.dtype(value)
 48
 49    def valid(self, value):
 50        # Not valid if wrong data type
 51        if not isinstance(value, self.dtype):
 52            logging.error(f"Value {value} is not of valid type {self.dtype} but of type {type(value)}.")
 53            return False
 54
 55        # Not valid if not in range
 56        if not self.inrange(value):
 57            return False
 58
 59        # Valid
 60        return True
 61
 62    def get_name(self):
 63        if self.name:
 64            return self.name
 65        name = self.key.replace("_", " ").strip().lower()
 66        return name
 67
 68    def validate_dtype(self, value):
 69        can_be_none = self.default is None
 70        # given custom value is None which is a valid data type
 71        if can_be_none and value is None:
 72            return
 73        # given custom value is of valid data type
 74        if isinstance(value, self.dtype):
 75            return
 76        # given custom value is int but float is valid
 77        if self.dtype is float and isinstance(value, int):
 78            return
 79        raise TypeError(
 80            f"You set {self.key} to be '{value}' which is of type {type(value)} but it should be {self.dtype} {'or None' if can_be_none else ''}"
 81        )
 82
 83    def validate_inrange(self, value):
 84        if self.inrange(value):
 85            return
 86        raise ValueError(f"{self.key} is set to be '{value}' which is outside of the valid range '{self.drange}'.")
 87
 88    def validate_serverrange(self, value):
 89        if self.serverrange(value):
 90            return
 91        raise ValueError(
 92            f"{self.key} is set to be '{value}' which is outside of the valid server range '{self.drange}'."
 93        )
 94
 95    def generate_full_evalrange(self):
 96        if self.evalrange is not None:
 97            n_datapoints = 10
 98            from numpy import linspace
 99
100            return linspace(self.evalrange[0], self.evalrange[1], n_datapoints)