Skip to main content
Ctrl+K

boa documentation

Site Navigation

  • Overview
  • User guide
  • Examples
  • Troubleshooting
  • Changelog
  • Code reference
  • Gallery

Site Navigation

  • Overview
  • User guide
  • Examples
  • Troubleshooting
  • Changelog
  • Code reference
  • Gallery

Section Navigation

  • boa.metrics
    • boa.metrics.metric_funcs
      • boa.metrics.metric_funcs.metric_from_json
      • boa.metrics.metric_funcs.metric_from_yaml
      • boa.metrics.metric_funcs.normalized_root_mean_squared_error
    • boa.metrics.metrics
      • boa.metrics.metrics.MSE
      • boa.metrics.metrics.MeanSquaredError
      • boa.metrics.metrics.R2
      • boa.metrics.metrics.RMSE
      • boa.metrics.metrics.RSquared
      • boa.metrics.metrics.RootMeanSquaredError
      • boa.metrics.metrics.get_metric_by_class_name
      • boa.metrics.metrics.get_metric_from_config
      • boa.metrics.metrics.get_synth_func
      • boa.metrics.metrics.mean_squared_error
      • boa.metrics.metrics.root_mean_squared_error
      • boa.metrics.metrics.setup_sklearn_metric
      • boa.metrics.metrics.setup_synthetic_metric
      • boa.metrics.metrics.MetricToEval
      • boa.metrics.metrics.ModularMetric
    • boa.metrics.synthethic_funcs
      • boa.metrics.synthethic_funcs.Hartmann4
  • boa.ax_instantiation_utils
    • boa.ax_instantiation_utils.choose_generation_strategy_from_experiment
    • boa.ax_instantiation_utils.generation_strategy_from_config
    • boa.ax_instantiation_utils.get_experiment
    • boa.ax_instantiation_utils.get_generation_strategy
    • boa.ax_instantiation_utils.get_optimization_config
    • boa.ax_instantiation_utils.get_scheduler
    • boa.ax_instantiation_utils.instantiate_search_space_from_json
  • boa.metaclasses
    • boa.metaclasses.MetricRegister
    • boa.metaclasses.MetricToEvalRegister
    • boa.metaclasses.RunnerRegister
    • boa.metaclasses.WrapperRegister
  • boa.runner
    • boa.runner.WrappedJobRunner
  • boa.scheduler
  • boa.storage
    • boa.storage.load_experiment
    • boa.storage.pickle_obj
    • boa.storage.save_experiment
    • boa.storage.scheduler_from_json_file
    • boa.storage.scheduler_from_json_snapshot
    • boa.storage.scheduler_to_json_file
    • boa.storage.scheduler_to_json_snapshot
    • boa.storage.unpickle_obj
  • boa.utils
    • boa.utils.convert_type
    • boa.utils.get_callable_signature
    • boa.utils.get_dictionary_from_callable
    • boa.utils.get_dictionary_matching_signature
    • boa.utils.serialize_init_args
  • boa.wrapper
    • boa.wrapper.BaseWrapper
  • boa.wrapper_utils
    • boa.wrapper_utils.boa_params_to_wpr
    • boa.wrapper_utils.cd_and_cd_back
    • boa.wrapper_utils.cd_and_cd_back_dec
    • boa.wrapper_utils.get_trial_dir
    • boa.wrapper_utils.load_yaml
    • boa.wrapper_utils.make_experiment_dir
    • boa.wrapper_utils.make_trial_dir
    • boa.wrapper_utils.normalize_config
    • boa.wrapper_utils.wpr_params_to_boa
    • boa.wrapper_utils.write_configs
  • Code reference
  • boa.metrics
  • boa.metrics.metrics

boa.metrics.metrics#

Metrics

Built-in metrics:

  • MSE, MeanSquaredError

  • RMSE, RootMeanSquaredError

  • R2, RSquared

Functions

MSE

MeanSquaredError

R2

RMSE

RSquared

RootMeanSquaredError

get_metric_by_class_name

get_metric_from_config

get_synth_func

mean_squared_error

root_mean_squared_error

setup_sklearn_metric

setup_synthetic_metric

Classes

MetricToEval

ModularMetric

Metric is computed by evaluating a deterministic function, implemented in the f method defined on this class.

previous

boa.metrics.metric_funcs.normalized_root_mean_squared_error

next

boa.metrics.metrics.MSE
Show Source

© Copyright 2022, Madeline Scyphers, Justine Missik.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.3.