# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
# pyre-strict
from collections.abc import Iterable
from ax.analysis.analysis import Analysis, display_cards
from ax.analysis.overview import OverviewAnalysis
from ax.core.analysis_card import AnalysisCardBase
from ax.core.experiment import Experiment
from ax.generation_strategy.generation_strategy import GenerationStrategy
from ax.storage.sqa_store.with_db_settings_base import WithDBSettingsBase
[docs]
class AnalysisBase(WithDBSettingsBase):
"""
Base class for analysis functionality shared between AxClient and orchestrator.
"""
# pyre-fixme[13]: Attribute `experiment` is declared in class
# `AnalysisBase` to have type `Experiment` but is never initialized
experiment: Experiment
# pyre-fixme[13]: Attribute `generation_strategy` is declared in class
# `AnalysisBase` to have type `GenerationStrategy` but
# is never initialized
generation_strategy: GenerationStrategy
[docs]
def compute_analyses(
self,
analyses: Iterable[Analysis] | None = None,
display: bool = True,
) -> list[AnalysisCardBase]:
"""
Compute AnalysisCards (data about the optimization for end-user consumption)
using the Experiment and GenerationStrategy. If no analyses are provided use
some heuristic to determine which analyses to run. If some analyses fail, log
failure and continue to compute the rest.
Note that the Analysis class is NOT part of the API and its methods are subject
to change incompatibly between minor versions. Users are encouraged to use the
provided analyses or leave this argument as None to use the default analyses.
Saves to database on completion if storage_config is present.
Args:
analyses: A list of Analysis classes to run. If None Ax will choose which
analyses to run based on the state of the experiment.
display: Whether to display the AnalysisCards if executed in an interactive
environment (e.g. Jupyter). Defaults to True. If not in an interactive
environment this setting has no effect.
Returns:
A list of AnalysisCards.
"""
analyses = analyses if analyses is not None else [OverviewAnalysis()]
# Compute Analyses one by one and accumulate Results holding either the
# AnalysisCard or an Exception and some metadata
cards = [
analysis.compute_or_error_card(
experiment=self.experiment,
generation_strategy=self.generation_strategy,
)
for analysis in analyses
]
# Display the AnalysisCards if requested and if the user is in a notebook
if display:
display_cards(cards=cards)
return cards