mlos_bench package

mlos_bench is a framework to help automate benchmarking and and OS/application parameter autotuning.

Subpackages

• mlos_bench.config package
  • Subpackages
    • mlos_bench.config.schemas package
      • ConfigSchema
      • Submodules
• mlos_bench.environments package
  • CompositeEnv
    • CompositeEnv.children
    • CompositeEnv.pprint()
    • CompositeEnv.run()
    • CompositeEnv.setup()
    • CompositeEnv.status()
    • CompositeEnv.teardown()
  • Environment
    • Environment.new()
    • Environment.parameters
    • Environment.pprint()
    • Environment.run()
    • Environment.setup()
    • Environment.status()
    • Environment.teardown()
    • Environment.tunable_params
  • LocalEnv
    • LocalEnv.run()
    • LocalEnv.setup()
    • LocalEnv.status()
    • LocalEnv.teardown()
  • LocalFileShareEnv
    • LocalFileShareEnv.run()
    • LocalFileShareEnv.setup()
    • LocalFileShareEnv.status()
  • MockEnv
    • MockEnv.run()
  • RemoteEnv
    • RemoteEnv.run()
    • RemoteEnv.setup()
    • RemoteEnv.teardown()
  • Status
    • Status.CANCELED
    • Status.FAILED
    • Status.PENDING
    • Status.READY
    • Status.RUNNING
    • Status.SUCCEEDED
    • Status.TIMED_OUT
    • Status.UNKNOWN
    • Status.is_canceled()
    • Status.is_completed()
    • Status.is_failed()
    • Status.is_good()
    • Status.is_pending()
    • Status.is_ready()
    • Status.is_succeeded()
    • Status.is_timed_out()
  • Subpackages
    • mlos_bench.environments.local package
      • LocalEnv
      • LocalFileShareEnv
      • Submodules
    • mlos_bench.environments.remote package
      • HostEnv
      • NetworkEnv
      • OSEnv
      • RemoteEnv
      • SaaSEnv
      • VMEnv
      • Submodules
  • Submodules
    • mlos_bench.environments.base_environment module
      • Environment
    • mlos_bench.environments.composite_env module
      • CompositeEnv
    • mlos_bench.environments.mock_env module
      • MockEnv
    • mlos_bench.environments.script_env module
      • ScriptEnv
    • mlos_bench.environments.status module
      • Status
• mlos_bench.optimizers package
  • MlosCoreOptimizer
    • MlosCoreOptimizer.bulk_register()
    • MlosCoreOptimizer.get_best_observation()
    • MlosCoreOptimizer.name
    • MlosCoreOptimizer.register()
    • MlosCoreOptimizer.suggest()
  • MockOptimizer
    • MockOptimizer.bulk_register()
    • MockOptimizer.suggest()
  • OneShotOptimizer
    • OneShotOptimizer.supports_preload
  • Optimizer
    • Optimizer.BASE_SUPPORTED_CONFIG_PROPS
    • Optimizer.bulk_register()
    • Optimizer.config_space
    • Optimizer.current_iteration
    • Optimizer.direction
    • Optimizer.get_best_observation()
    • Optimizer.is_min
    • Optimizer.max_iterations
    • Optimizer.name
    • Optimizer.not_converged()
    • Optimizer.register()
    • Optimizer.seed
    • Optimizer.start_with_defaults
    • Optimizer.suggest()
    • Optimizer.supports_preload
    • Optimizer.target
    • Optimizer.tunable_params
  • Submodules
    • mlos_bench.optimizers.base_optimizer module
      • Optimizer
    • mlos_bench.optimizers.convert_configspace module
      • TunableValueKind
      • configspace_data_to_tunable_values()
      • special_param_name_is_temp()
      • special_param_name_strip()
      • special_param_names()
      • tunable_groups_to_configspace()
      • tunable_values_to_configuration()
    • mlos_bench.optimizers.grid_search_optimizer module
      • GridSearchOptimizer
    • mlos_bench.optimizers.mlos_core_optimizer module
      • MlosCoreOptimizer
    • mlos_bench.optimizers.mock_optimizer module
      • MockOptimizer
    • mlos_bench.optimizers.one_shot_optimizer module
      • OneShotOptimizer
    • mlos_bench.optimizers.track_best_optimizer module
      • TrackBestOptimizer
• mlos_bench.schedulers package
  • Scheduler
    • Scheduler.get_best_observation()
    • Scheduler.load_config()
    • Scheduler.not_done()
    • Scheduler.run_trial()
    • Scheduler.schedule_trial()
    • Scheduler.start()
    • Scheduler.teardown()
  • SyncScheduler
    • SyncScheduler.run_trial()
    • SyncScheduler.start()
  • Submodules
    • mlos_bench.schedulers.base_scheduler module
      • Scheduler
    • mlos_bench.schedulers.sync_scheduler module
      • SyncScheduler
• mlos_bench.services package
  • FileShareService
    • FileShareService.download()
    • FileShareService.upload()
  • LocalExecService
    • LocalExecService.local_exec()
  • Service
    • Service.config_loader_service
    • Service.export()
    • Service.merge_methods()
    • Service.new()
    • Service.pprint()
    • Service.register()
  • Subpackages
    • mlos_bench.services.local package
      • LocalExecService
      • Submodules
    • mlos_bench.services.remote package
      • Subpackages
    • mlos_bench.services.types package
      • SupportsAuth
      • SupportsConfigLoading
      • SupportsFileShareOps
      • SupportsHostProvisioning
      • SupportsLocalExec
      • SupportsNetworkProvisioning
      • SupportsRemoteConfig
      • SupportsRemoteExec
      • Submodules
  • Submodules
    • mlos_bench.services.base_fileshare module
      • FileShareService
    • mlos_bench.services.base_service module
      • Service
    • mlos_bench.services.config_persistence module
      • ConfigPersistenceService
• mlos_bench.storage package
  • Storage
    • Storage.Experiment
      • Storage.Experiment.description
      • Storage.Experiment.experiment_id
      • Storage.Experiment.load()
      • Storage.Experiment.load_telemetry()
      • Storage.Experiment.load_tunable_config()
      • Storage.Experiment.merge()
      • Storage.Experiment.new_trial()
      • Storage.Experiment.opt_direction
      • Storage.Experiment.opt_target
      • Storage.Experiment.pending_trials()
      • Storage.Experiment.trial_id
      • Storage.Experiment.tunables
    • Storage.Trial
      • Storage.Trial.config()
      • Storage.Trial.opt_direction
      • Storage.Trial.opt_target
      • Storage.Trial.trial_id
      • Storage.Trial.tunable_config_id
      • Storage.Trial.tunables
      • Storage.Trial.update()
      • Storage.Trial.update_telemetry()
    • Storage.experiment()
    • Storage.experiments
  • from_config()
  • Subpackages
    • mlos_bench.storage.sql package
      • SqlStorage
      • Submodules
  • Submodules
    • mlos_bench.storage.base_experiment_data module
      • ExperimentData
    • mlos_bench.storage.base_storage module
      • Storage
    • mlos_bench.storage.base_trial_data module
      • TrialData
    • mlos_bench.storage.base_tunable_config_data module
      • TunableConfigData
    • mlos_bench.storage.base_tunable_config_trial_group_data module
      • TunableConfigTrialGroupData
    • mlos_bench.storage.storage_factory module
      • from_config()
    • mlos_bench.storage.util module
      • kv_df_to_dict()
• mlos_bench.tunables package
  • Tunable
    • Tunable.cardinality
    • Tunable.categories
    • Tunable.category
    • Tunable.copy()
    • Tunable.default
    • Tunable.distribution
    • Tunable.distribution_params
    • Tunable.dtype
    • Tunable.in_range()
    • Tunable.is_categorical
    • Tunable.is_default()
    • Tunable.is_log
    • Tunable.is_numerical
    • Tunable.is_special
    • Tunable.is_valid()
    • Tunable.meta
    • Tunable.name
    • Tunable.numerical_value
    • Tunable.quantization
    • Tunable.quantized_values
    • Tunable.range
    • Tunable.range_weight
    • Tunable.span
    • Tunable.special
    • Tunable.type
    • Tunable.update()
    • Tunable.value
    • Tunable.values
    • Tunable.weights
  • TunableGroups
    • TunableGroups.assign()
    • TunableGroups.copy()
    • TunableGroups.get_covariant_group_names()
    • TunableGroups.get_param_values()
    • TunableGroups.get_tunable()
    • TunableGroups.is_defaults()
    • TunableGroups.is_updated()
    • TunableGroups.merge()
    • TunableGroups.reset()
    • TunableGroups.restore_defaults()
    • TunableGroups.subgroup()
  • Submodules
    • mlos_bench.tunables.covariant_group module
      • CovariantTunableGroup
    • mlos_bench.tunables.tunable module
      • DistributionDict
      • Tunable
      • TunableDict
      • TunableValue
      • TunableValueType
      • TunableValueTypeName
      • TunableValueTypeTuple
      • TunableValuesDict
    • mlos_bench.tunables.tunable_groups module
      • TunableGroups

Submodules

• mlos_bench.dict_templater module
  • DictTemplater
    • DictTemplater.expand_vars()
• mlos_bench.event_loop_context module
  • EventLoopContext
    • EventLoopContext.enter()
    • EventLoopContext.exit()
    • EventLoopContext.run_coroutine()
• mlos_bench.launcher module
  • Launcher
    • Launcher.config_loader
    • Launcher.service
• mlos_bench.os_environ module
  • Example
• mlos_bench.run module
• mlos_bench.util module
  • check_required_params()
  • datetime_parser()
  • get_class_from_name()
  • get_git_info()
  • instantiate_from_config()
  • merge_parameters()
  • nullable()
  • path_join()
  • prepare_class_load()
  • preprocess_dynamic_configs()
  • try_parse_val()
  • utcify_nullable_timestamp()
  • utcify_timestamp()