Skip to content

Commit

Permalink
fixups
Browse files Browse the repository at this point in the history
  • Loading branch information
bpkroth committed Jan 23, 2025
1 parent 17d8751 commit 766d2ed
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions mlos_bench/mlos_bench/config/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
for some examples of CLI configs.
Globals and Variable Substitution
+++++++++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:py:attr:`Globals <mlos_bench.config.schemas.config_schemas.ConfigSchema.GLOBALS>`
are basically just key-value variables that can be used in other configs using
Expand Down Expand Up @@ -208,14 +208,15 @@
Here is a list of some well known variables that are provided or required by the
system and may be used in the config files:
- ``$experiment_id``: A unique identifier for the ``Experiment``.
- ``$experiment_id`` : A unique identifier for the ``Experiment``.
Typically provided in globals.
- ``$trial_id``: A unique identifier for the ``Trial`` currently being executed.
- ``$trial_id`` : A unique identifier for the ``Trial`` currently being executed.
This can be useful in the configs for :py:mod:`mlos_bench.environments` for
instance (e.g., when writing scripts).
- ``$trial_runner_id``: A unique identifier for the ``TrialRunner``.
This can be useful when running multiple trials in parallel (e.g., to
provision a numbered VM per worker).
- ``$trial_runner_id`` : A unique identifier for the
:py:class:`~mlos_bench.schedulers.trial_runner.TrialRunner`. This can be
useful when running multiple trials in parallel (e.g., to provision a
numbered VM per worker).
Tunable Configs
^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -311,7 +312,7 @@
expected structure of the ``config`` section.
In certain cases (e.g., script command execution) the variable substitution rules
take on slightly different behavior
take on slightly different behavior.
See various documentation in :py:mod:`mlos_bench.environments` for more details.
Config Processing
Expand Down

0 comments on commit 766d2ed

Please sign in to comment.