mlos_bench.environments.remote.host_env module¶
Remote host Environment.
- class mlos_bench.environments.remote.host_env.HostEnv(*, name: str, config: dict, global_config: dict | None = None, tunables: TunableGroups | None = None, service: Service | None = None)¶
Bases:
Environment
Remote host environment.
- Attributes:
parameters
Key/value pairs of all environment parameters (i.e., const_args and tunable_params).
tunable_params
Get the configuration space of the given environment.
Methods
new
(*, env_name, class_name, config[, ...])Factory method for a new environment with a given config.
pprint
([indent, level])Pretty-print the environment configuration.
run
()Execute the run script for this environment.
setup
(tunables[, global_config])Check if host is ready.
status
()Check the status of the benchmark environment.
teardown
()Shut down the Host and release it.
- setup(tunables: TunableGroups, global_config: dict | None = None) bool ¶
Check if host is ready. (Re)provision and start it, if necessary.
- Parameters:
- tunablesTunableGroups
A collection of groups of tunable parameters along with the parameters’ values. HostEnv tunables are variable parameters that, together with the HostEnv configuration, are sufficient to provision and start a Host.
- global_configdict
Free-format dictionary of global parameters of the environment that are not used in the optimization process.
- Returns:
- is_successbool
True if operation is successful, false otherwise.
- teardown() None ¶
Shut down the Host and release it.