Update logging for parameters

Author: till-m

bayes_opt/logger.py

@@ -169,7 +169,7 @@ def _step(self, instance: BayesianOptimization, colour: str = _colour_regular_me
             cells[2] = self._format_bool(res["allowed"])
         params = res.get("params", {})
         cells[3:] = [
-            instance.space._params_config[key].repr(val, self._default_cell_size)
+            instance.space._params_config[key].to_string(val, self._default_cell_size)
             for key, val in params.items()
         ]
 

bayes_opt/parameter.py

@@ -120,7 +120,7 @@ def kernel_transform(self, value: NDArray[Float]) -> NDArray[Float]:
         np.ndarray
         """
 
-    def repr(self, value: Any, str_len: int) -> str:
+    def to_string(self, value: Any, str_len: int) -> str:
         """Represent a parameter value as a string.
 
         Parameters
@@ -135,11 +135,9 @@ def repr(self, value: Any, str_len: int) -> str:
         -------
         str
         """
-        s = repr(value)
+        s = f"{value!r:<{str_len}}"
 
         if len(s) > str_len:
-            if "." in s:
-                return s[:str_len]
             return s[: str_len - 3] + "..."
         return s
 
@@ -194,7 +192,7 @@ def to_param(self, value: float | NDArray[Float]) -> float:
             return value
         return value.flatten()[0]
 
-    def repr(self, value: float, str_len: int) -> str:
+    def to_string(self, value: float, str_len: int) -> str:
         """Represent a parameter value as a string.
 
         Parameters
@@ -211,7 +209,7 @@ def repr(self, value: float, str_len: int) -> str:
         """
         s = f"{value:<{str_len}.{str_len}}"
         if len(s) > str_len:
-            if "." in s:
+            if "." in s and "e" not in s:
                 return s[:str_len]
             return s[: str_len - 3] + "..."
         return s
@@ -297,28 +295,6 @@ def to_param(self, value: int | float | NDArray[Int] | NDArray[Float]) -> int:
         """
         return int(np.round(np.squeeze(value)))
 
-    def repr(self, value: int, str_len: int) -> str:
-        """Represent a parameter value as a string.
-
-        Parameters
-        ----------
-        value : Any
-            The value to represent.
-
-        str_len : int
-            The maximum length of the string representation.
-
-        Returns
-        -------
-        str
-        """
-        s = f"{value:<{str_len}}"
-        if len(s) > str_len:
-            if "." in s:
-                return s[:str_len]
-            return s[: str_len - 3] + "..."
-        return s
-
     def kernel_transform(self, value: NDArray[Float]) -> NDArray[Float]:
         """Transform a parameter value for use in a kernel.
 
@@ -352,6 +328,13 @@ class CategoricalParameter(BayesParameter):
     """
 
     def __init__(self, name: str, categories: Sequence[Any]) -> None:
+        if len(categories) != len(set(categories)):
+            msg = "Categories must be unique."
+            raise ValueError(msg)
+        if len(categories) < 2:
+            msg = "At least two categories are required."
+            raise ValueError(msg)
+
         self.categories = categories
         lower = np.zeros(self.dim)
         upper = np.ones(self.dim)
@@ -412,7 +395,7 @@ def to_param(self, value: float | NDArray[Float]) -> Any:
         """
         return self.categories[int(np.argmax(value))]
 
-    def repr(self, value: Any, str_len: int) -> str:
+    def to_string(self, value: Any, str_len: int) -> str:
         """Represent a parameter value as a string.
 
         Parameters
@@ -427,7 +410,10 @@ def repr(self, value: Any, str_len: int) -> str:
         -------
         str
         """
-        s = f"{value:^{str_len}}"
+        if not isinstance(value, str):
+            value = repr(value)
+        s = f"{value:<{str_len}}"
+
         if len(s) > str_len:
             return s[: str_len - 3] + "..."
         return s

tests/test_parameter.py

@@ -70,13 +70,13 @@ def target_func(**kwargs):
 
 
 def test_cat_parameters():
-    fruit_ratings = {"apple": 1.0, "banana": 2.0, "mango": 5.0, "honeydew melon": -10.0, "straberry": np.pi}
+    fruit_ratings = {"apple": 1.0, "banana": 2.0, "mango": 5.0, "honeydew melon": -10.0, "strawberry": np.pi}
 
     def target_func(fruit: str):
         return fruit_ratings[fruit]
 
-    fruits = ("apple", "banana", "mango", "honeydew melon", "straberry")
-    pbounds = {"fruit": ("apple", "banana", "mango", "honeydew melon", "straberry")}
+    fruits = ("apple", "banana", "mango", "honeydew melon", "strawberry")
+    pbounds = {"fruit": ("apple", "banana", "mango", "honeydew melon", "strawberry")}
     space = TargetSpace(target_func, pbounds)
 
     assert space.dim == len(fruits)
@@ -101,3 +101,35 @@ def target_func(fruit: str):
     assert (space.params[1] == np.array([0, 0, 0, 1, 0])).all()
 
     assert (space.target == np.array([target1, target2])).all()
+
+
+def test_to_string():
+    pbounds = {"p1": (0, 1), "p2": (1, 2)}
+    space = TargetSpace(None, pbounds)
+
+    assert space._params_config["p1"].to_string(0.2, 5) == "0.2  "
+    assert space._params_config["p2"].to_string(1.5, 5) == "1.5  "
+    assert space._params_config["p1"].to_string(0.2, 3) == "0.2"
+    assert space._params_config["p2"].to_string(np.pi, 5) == "3.141"
+    assert space._params_config["p1"].to_string(1e-5, 6) == "1e-05 "
+    assert space._params_config["p2"].to_string(-1e-5, 6) == "-1e-05"
+    assert space._params_config["p1"].to_string(1e-15, 5) == "1e-15"
+    assert space._params_config["p1"].to_string(-1.2e-15, 7) == "-1.2..."
+
+    pbounds = {"p1": (0, 5, int), "p3": (-1, 3, int)}
+    space = TargetSpace(None, pbounds)
+
+    assert space._params_config["p1"].to_string(2, 5) == "2    "
+    assert space._params_config["p3"].to_string(0, 5) == "0    "
+    assert space._params_config["p1"].to_string(2, 3) == "2  "
+    assert space._params_config["p3"].to_string(-1, 5) == "-1   "
+    assert space._params_config["p1"].to_string(123456789, 6) == "123..."
+
+    pbounds = {"fruit": ("apple", "banana", "mango", "honeydew melon", "strawberry")}
+    space = TargetSpace(None, pbounds)
+
+    assert space._params_config["fruit"].to_string("apple", 5) == "apple"
+    assert space._params_config["fruit"].to_string("banana", 5) == "ba..."
+    assert space._params_config["fruit"].to_string("mango", 5) == "mango"
+    assert space._params_config["fruit"].to_string("honeydew melon", 10) == "honeyde..."
+    assert space._params_config["fruit"].to_string("strawberry", 10) == "strawberry"