docs

microsoft · Oct 4, 2024 · 1fa1275 · 1fa1275
1 parent 954d4cb
commit 1fa1275
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/mlos_bench/mlos_bench/tunables/tunable_groups.py b/mlos_bench/mlos_bench/tunables/tunable_groups.py
@@ -346,6 +346,12 @@ def assign(self, param_values: Mapping[str, TunableValue]) -> "TunableGroups":
         param_values : Mapping[str, TunableValue]
             Dictionary mapping Tunable parameter names to new values.
 
+            As a special behavior when the mapping is empty the method will restore
+            the default values rather than no-op.
+            This allows an empty dictionary in json configs to be used to reset the
+            tunables to defaults without having to copy the original values from the
+            tunable_params definition.
+
         Returns
         -------
         self : TunableGroups