tweaks

microsoft · Dec 5, 2024 · b5fd716 · b5fd716
1 parent cb15986
commit b5fd716
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/mlos_bench/mlos_bench/environments/__init__.py b/mlos_bench/mlos_bench/environments/__init__.py
@@ -116,9 +116,11 @@
 
 See Also
 --------
-:py:mod:`mlos_bench.config`
-:py:mod:`mlos_bench.services`
-:py:mod:`mlos_bench.tunables`
+:py:mod:`mlos_bench.config` : Overview of the configuration system.
+:py:mod:`mlos_bench.services` : Overview of the Services available to the
+    Environments and their configurations.
+:py:mod:`mlos_bench.tunables` : Overview of the Tunables available to the
+    Environments and their configurations.
 """
 
 from mlos_bench.environments.base_environment import Environment

diff --git a/mlos_bench/mlos_bench/tunables/__init__.py b/mlos_bench/mlos_bench/tunables/__init__.py
@@ -201,10 +201,10 @@
 
 See Also
 --------
-:py:mod:`mlos_bench.config`
-:py:mod:`mlos_bench.environments`
-:py:mod:`mlos_core.optimizers`
-:py:mod:`mlos_core.spaces`
+:py:mod:`mlos_bench.config` : Overview of the configuration system.
+:py:mod:`mlos_bench.environments` : Overview of Environments and their configurations.
+:py:mod:`mlos_core.optimizers` : Overview of mlos_core optimizers.
+:py:mod:`mlos_core.spaces` : Overview of the mlos_core configuration space system.
 """
 
 from mlos_bench.tunables.tunable import Tunable, TunableValue