mlos_bench.environments.remote.saas_env

Cloud-based (configurable) SaaS environment.

Classes

SaaSEnv

Cloud-based (configurable) SaaS environment.

Module Contents

class mlos_bench.environments.remote.saas_env.SaaSEnv(*, name: str, config: dict, global_config: dict | None = None, tunables: mlos_bench.tunables.tunable_groups.TunableGroups | None = None, service: mlos_bench.services.base_service.Service | None = None)[source]

Bases: mlos_bench.environments.base_environment.Environment

Cloud-based (configurable) SaaS environment.

Create a new environment for (configurable) cloud-based SaaS instance.

Parameters:

  • name (str) – Human-readable name of the environment.

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

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

  • tunables (TunableGroups) – A collection of tunable parameters for all environments.

  • service (Service) – An optional service object (e.g., providing methods to configure the remote service).

setup(tunables: mlos_bench.tunables.tunable_groups.TunableGroups, global_config: dict | None = None) → bool[source]

Update the configuration of a remote SaaS instance.

Parameters:

  • tunables (TunableGroups) – A collection of groups of tunable parameters along with the parameters’ values.

  • global_config (dict) – Free-format dictionary of global parameters of the environment that are not used in the optimization process.

Returns:

is_success – True if operation is successful, false otherwise.

Return type:

bool