MAINT add docstring

ml-squad · Feb 14, 2017 · b638d44 · b638d44
1 parent 2a336af
commit b638d44
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/smac/configspace/util.py b/smac/configspace/util.py
@@ -6,6 +6,20 @@
 
 
 def impute_inactive_hyperparameters(configs: List[Configuration]) -> np.ndarray:
+    """Impute inactive hyperparameters in configurations with their default.
+
+    Necessary to apply an EPM to the data.
+
+    Parameters
+    ----------
+    configs : List[Configuration]
+        List of configuration objects.
+
+    Returns
+    np.ndarray
+        Array with configuration hyperparameters. Inactive values are imputed
+        with their default value.
+    """
     configs_array = np.array([config.get_array() for config in configs],
                              dtype=np.float64)
     configuration_space = configs[0].configuration_space