mlos_bench.environments.remote.saas_env module¶
Cloud-based (configurable) SaaS environment.
- class mlos_bench.environments.remote.saas_env.SaaSEnv(*, name: str, config: dict, global_config: dict | None = None, tunables: TunableGroups | None = None, service: Service | None = None)¶
Bases:
Environment
Cloud-based (configurable) SaaS 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])Update the configuration of a remote SaaS instance.
status
()Check the status of the benchmark environment.
teardown
()Tear down the benchmark environment.
- setup(tunables: TunableGroups, global_config: dict | None = None) bool ¶
Update the configuration of a remote SaaS instance.
- Parameters:
- tunablesTunableGroups
A collection of groups of tunable parameters along with the parameters’ values.
- 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.