Skip to content

Commit

Permalink
Add docstring to compute_analyses
Browse files Browse the repository at this point in the history
Summary: Redo of D64404361 to unstack from Lena's diffs

Differential Revision: D64426639
  • Loading branch information
mpolson64 authored and facebook-github-bot committed Oct 15, 2024
1 parent c555154 commit b75fd2e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions ax/service/scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -1851,6 +1851,16 @@ def generate_candidates(
def compute_analyses(
self, analyses: Iterable[Analysis] | None = None
) -> list[AnalysisCard]:
"""
Compute Analyses for the Experiment and GenerationStrategy associated with this
Scheduler instance and save them to the DB if possible. If an Analysis fails to
compute (e.g. due to a missing metric), it will be skipped and a warning will
be logged.
Args:
analyses: Analyses to compute. If None, the Scheduler will choose a set of
Analyses to compute based on the Experiment and GenerationStrategy.
"""
analyses = analyses if analyses is not None else self._choose_analyses()

results = [
Expand Down

0 comments on commit b75fd2e

Please sign in to comment.