0.13.2

Updated plot_important_hyperparameter_contour function

Author: bartzbeielstein

notebooks/00_spotPython_tests.ipynb

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spotPython"
-version = "0.13.1"
+version = "0.13.2"
 authors = [
   { name="T. Bartz-Beielstein", email="tbb@bartzundbartz.de" }
 ]

pyproject.toml

@@ -28,7 +28,7 @@
 import logging
 import time
 from spotPython.utils.progress import progress_bar
-from spotPython.utils.convert import find_indices
+from spotPython.utils.convert import find_indices, sort_by_kth_and_return_indices
 from spotPython.hyperparameters.values import (
     get_control_key_value,
     get_ith_hyperparameter_name_from_fun_control,
@@ -1640,7 +1640,7 @@ def plot_contour(
             pylab.show()
 
     def plot_important_hyperparameter_contour(
-        self, threshold=0.0, filename=None, show=True, max_imp=None, title=""
+        self, threshold=0.0, filename=None, show=True, max_imp=None, title="", scale_global=False
     ) -> None:
         """
         Plot the contour of important hyperparameters.
@@ -1649,7 +1649,7 @@ def plot_important_hyperparameter_contour(
 
         Args:
             threshold (float):
-                threshold for the importance
+                threshold for the importance. Not used any more in spotPython >= 0.13.2.
             filename (str):
                 filename of the plot
             show (bool):
@@ -1691,23 +1691,22 @@ def plot_important_hyperparameter_contour(
                 S.plot_important_hyperparameter_contour()
 
         """
-        impo_org = self.print_importance(threshold=threshold, print_screen=True)
-        print(f"impo: {impo_org}")
-        try:
-            impo = sorted(impo_org, key=lambda x: x[1], reverse=True)
-        except ValueError as e:
-            print(f"ValueError: {e}")
-            impo = impo_org
-        # if there are more than imp_max variables, select only the most important ones:
+        impo = self.print_importance(threshold=threshold, print_screen=True)
+        print(f"impo: {impo}")
+        indices = sort_by_kth_and_return_indices(array=impo, k=1)
+        print(f"indices: {indices}")
+        # take the first max_imp values from the indices array
         if max_imp is not None:
-            if len(impo) > max_imp:
-                impo = impo[:max_imp]
-        print(f"impo after select: {impo}")
-        var_plots = [i for i, x in enumerate(impo) if x[1] > threshold]
-        min_z = min(self.y)
-        max_z = max(self.y)
-        for i in var_plots:
-            for j in var_plots:
+            indices = indices[:max_imp]
+        print(f"indices after max_imp selection: {indices}")
+        if scale_global:
+            min_z = min(self.y)
+            max_z = max(self.y)
+        else:
+            min_z = None
+            max_z = None
+        for i in indices:
+            for j in indices:
                 if j > i:
                     if filename is not None:
                         filename_full = filename + "_contour_" + str(i) + "_" + str(j) + ".png"

src/spotPython/spot/spot.py

@@ -139,3 +139,43 @@ def map_to_True_False(value):
         return True
     else:
         return False
+
+
+def sort_by_kth_and_return_indices(array, k):
+    """Sorts an array of arrays based on the k-th values in descending order and returns
+    the indices of the original array entries.
+
+    Args:
+        array (list of lists): The array to be sorted. Each sub-array should have at least
+            `k+1` elements.
+        k (int): The index (zero-based) of the element within each sub-array to sort by.
+
+    Returns:
+        list of int: Indices of the original array entries after sorting by the k-th value.
+
+    Raises:
+        ValueError: If the input array is empty, None, or any sub-array does not have at least
+            `k+1` elements, or if k is out of bounds for any sub-array.
+
+    Examples:
+        >>> from spotPython.utils.convert import sort_by_kth_and_return_indices
+            try:
+                array = [['x0', 85.50983192204619], ['x1', 100.0], ['x2', 81.35712613549178]]
+                k = 1  # Sort by the second element in each sub-array
+                indices = sort_by_kth_and_return_indices(array, k)
+                print("Indices of the sorted elements using the k-th value:", indices)
+            except ValueError as error:
+                print(f"Sorting failed due to: {error}")
+    """
+    if not array:
+        return []
+
+    # Check for improperly structured sub-arrays and that k is within bounds
+    for item in array:
+        if not isinstance(item, list) or len(item) <= k:
+            raise ValueError("All sub-arrays must be lists with at least k+1 elements.")
+
+    # Enumerate the array to keep track of original indices, then sort by the k-th item
+    sorted_indices = [index for index, value in sorted(enumerate(array), key=lambda x: x[1][k], reverse=True)]
+
+    return sorted_indices