mlos_bench.environments.remote.VMEnv

class mlos_bench.environments.remote.VMEnv(*, name: str, config: dict, global_config: dict | None = None, tunables: TunableGroups | None = None, service: Service | None = None)

Remote VM/host environment.

Note: this is just a class alias for HostEnv for historical purposes.

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.

__init__(*, name: str, config: dict, global_config: dict | None = None, tunables: TunableGroups | None = None, service: Service | None = None)

Create a new environment for host operations.

Parameters:
name: str

Human-readable name of the environment.

configdict

Free-format dictionary that contains the benchmark environment configuration. Each config must have at least the “tunable_params” and the “const_args” sections.

global_configdict

Free-format dictionary of global parameters (e.g., security credentials) to be mixed in into the “const_args” section of the local config.

tunablesTunableGroups

A collection of tunable parameters for all environments.

service: Service

An optional service object (e.g., providing methods to deploy or reboot a VM/host, etc.).