Move analysis_card to ax/core (#4647)

mpolson64 · meta-codesync[bot] · commit e4c923c9f207 · 2025-12-15T12:04:34.000-08:00
Summary: Pull Request resolved: #4647 Motivated by storage work, where we want the AnalysisCard to become a true member of Ax's data model rather than needing to be saved a-la-carte via helper methods. In the future we will being saving AnalysisCards as attributes on the experiment so they can be (lazy) loaded together by default. Note that we are only moving the base AnalysisCard subclasses, not requireing Plotly, Graphviz, Markdown, etc -- those subclasses will remain in Analysis along with the concrete Analyses. Also note that no notebook users would have any use for importing AnalysisCard directly (they import concrete Analyses if anything), so we should not worry about any disruption there Reviewed By: Cesar-Cardoso Differential Revision: D88860614
diff --git a/ax/analysis/__init__.py b/ax/analysis/__init__.py
@@ -6,7 +6,6 @@
 # pyre-strict
 
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard
 from ax.analysis.best_trials import BestTrials
 from ax.analysis.metric_summary import MetricSummary
 from ax.analysis.search_space_summary import SearchSpaceSummary
@@ -17,7 +16,6 @@
 
 __all__ = [
     "Analysis",
-    "AnalysisCard",
     "BestTrials",
     "MetricSummary",
     "SearchSpaceSummary",
diff --git a/ax/analysis/analysis.py b/ax/analysis/analysis.py
@@ -13,7 +13,7 @@
 
 import pandas as pd
 from ax.adapter.base import Adapter
-from ax.analysis.analysis_card import (
+from ax.core.analysis_card import (
     AnalysisCard,
     AnalysisCardBase,
     AnalysisCardGroup,
diff --git a/ax/analysis/diagnostics.py b/ax/analysis/diagnostics.py
@@ -9,9 +9,9 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.plotly.cross_validation import CrossValidationPlot
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.core.experiment import Experiment
 from ax.core.utils import is_bandit_experiment
 from ax.generation_strategy.generation_strategy import GenerationStrategy
diff --git a/ax/analysis/graphviz/graphviz_analysis.py b/ax/analysis/graphviz/graphviz_analysis.py
@@ -6,7 +6,7 @@
 # pyre-strict
 
 import pandas as pd
-from ax.analysis.analysis_card import AnalysisCard
+from ax.core.analysis_card import AnalysisCard
 from graphviz import Digraph, Source
 
 
diff --git a/ax/analysis/graphviz/hierarchical_search_space_graph.py b/ax/analysis/graphviz/hierarchical_search_space_graph.py
@@ -7,13 +7,13 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard
 from ax.analysis.graphviz.graphviz_analysis import (
     create_graphviz_analysis_card,
     GraphvizAnalysisCard,
 )
 from ax.analysis.search_space_summary import SearchSpaceSummary
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCard
 from ax.core.experiment import Experiment
 from ax.core.parameter import Parameter
 from ax.core.search_space import SearchSpace
diff --git a/ax/analysis/healthcheck/healthcheck_analysis.py b/ax/analysis/healthcheck/healthcheck_analysis.py
@@ -9,7 +9,7 @@
 from enum import IntEnum
 
 import pandas as pd
-from ax.analysis.analysis_card import AnalysisCard
+from ax.core.analysis_card import AnalysisCard
 
 
 class HealthcheckStatus(IntEnum):
diff --git a/ax/analysis/insights.py b/ax/analysis/insights.py
@@ -9,14 +9,14 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardBase, AnalysisCardGroup
 from ax.analysis.plotly.marginal_effects import MarginalEffectsPlot
 from ax.analysis.plotly.objective_p_feasible_frontier import (
     ObjectivePFeasibleFrontierPlot,
 )
 from ax.analysis.plotly.p_feasible import PFeasiblePlot
 from ax.analysis.plotly.top_surfaces import TopSurfacesAnalysis
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCardBase, AnalysisCardGroup
 from ax.core.batch_trial import BatchTrial
 from ax.core.experiment import Experiment
 from ax.core.utils import is_bandit_experiment
diff --git a/ax/analysis/markdown/markdown_analysis.py b/ax/analysis/markdown/markdown_analysis.py
@@ -9,7 +9,7 @@
 import markdown
 import pandas as pd
 
-from ax.analysis.analysis_card import AnalysisCard
+from ax.core.analysis_card import AnalysisCard
 from IPython.display import Markdown
 
 
diff --git a/ax/analysis/metric_summary.py b/ax/analysis/metric_summary.py
@@ -10,8 +10,8 @@
 from ax.adapter.base import Adapter
 
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCard
 from ax.core.experiment import Experiment
 from ax.generation_strategy.generation_strategy import GenerationStrategy
 from pyre_extensions import none_throws, override
diff --git a/ax/analysis/overview.py b/ax/analysis/overview.py
@@ -9,7 +9,6 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis, ErrorAnalysisCard
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.diagnostics import DiagnosticAnalysis
 from ax.analysis.healthcheck.can_generate_candidates import (
     CanGenerateCandidatesAnalysis,
@@ -25,6 +24,7 @@
 from ax.analysis.results import ResultsAnalysis
 from ax.analysis.trials import AllTrialsAnalysis
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.core.experiment import Experiment
 from ax.core.trial_status import TrialStatus
 from ax.exceptions.core import UserInputError
diff --git a/ax/analysis/plotly/arm_effects.py b/ax/analysis/plotly/arm_effects.py
@@ -11,7 +11,6 @@
 from ax.adapter.base import Adapter
 
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard, AnalysisCardGroup
 from ax.analysis.plotly.color_constants import BOTORCH_COLOR_SCALE
 from ax.analysis.plotly.plotly_analysis import create_plotly_analysis_card
 from ax.analysis.plotly.utils import (
@@ -35,6 +34,7 @@
     validate_experiment,
     validate_experiment_has_trials,
 )
+from ax.core.analysis_card import AnalysisCard, AnalysisCardGroup
 from ax.core.arm import Arm
 from ax.core.base_trial import sort_by_trial_index_and_arm_name
 from ax.core.experiment import Experiment
diff --git a/ax/analysis/plotly/cross_validation.py b/ax/analysis/plotly/cross_validation.py
@@ -12,11 +12,11 @@
 from ax.adapter.base import Adapter
 from ax.adapter.cross_validation import cross_validate, CVResult
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardBase
 from ax.analysis.plotly.color_constants import AX_BLUE
 from ax.analysis.plotly.plotly_analysis import create_plotly_analysis_card
 from ax.analysis.plotly.utils import get_scatter_point_color, Z_SCORE_95_CI
 from ax.analysis.utils import extract_relevant_adapter, validate_adapter_can_predict
+from ax.core.analysis_card import AnalysisCardBase
 from ax.core.experiment import Experiment
 from ax.generation_strategy.generation_strategy import GenerationStrategy
 from plotly import graph_objects as go
diff --git a/ax/analysis/plotly/marginal_effects.py b/ax/analysis/plotly/marginal_effects.py
@@ -10,10 +10,10 @@
 import pandas as pd
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.plotly.color_constants import COLOR_FOR_DECREASES, COLOR_FOR_INCREASES
 from ax.analysis.plotly.plotly_analysis import create_plotly_analysis_card
 from ax.analysis.utils import extract_relevant_adapter, validate_experiment
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.core.experiment import Experiment
 from ax.core.parameter import ChoiceParameter
 from ax.generation_strategy.generation_strategy import GenerationStrategy
diff --git a/ax/analysis/plotly/plotly_analysis.py b/ax/analysis/plotly/plotly_analysis.py
@@ -7,7 +7,7 @@
 
 
 import pandas as pd
-from ax.analysis.analysis_card import AnalysisCard
+from ax.core.analysis_card import AnalysisCard
 from plotly import graph_objects as go, io as pio
 
 # Body HTML template for Plotly figures with a couple tricks for rendering in Jupyter.
diff --git a/ax/analysis/plotly/sensitivity.py b/ax/analysis/plotly/sensitivity.py
@@ -10,7 +10,6 @@
 from ax.adapter.base import Adapter
 from ax.adapter.torch import TorchAdapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard, AnalysisCardGroup
 from ax.analysis.plotly.color_constants import COLOR_FOR_DECREASES, COLOR_FOR_INCREASES
 from ax.analysis.plotly.plotly_analysis import create_plotly_analysis_card
 from ax.analysis.plotly.utils import (
@@ -21,6 +20,7 @@
     truncate_label,
 )
 from ax.analysis.utils import extract_relevant_adapter, validate_experiment
+from ax.core.analysis_card import AnalysisCard, AnalysisCardGroup
 from ax.core.experiment import Experiment
 from ax.generation_strategy.generation_strategy import GenerationStrategy
 from ax.utils.sensitivity.sobol_measures import ax_parameter_sens
diff --git a/ax/analysis/plotly/surface/slice.py b/ax/analysis/plotly/surface/slice.py
@@ -11,7 +11,6 @@
 import pandas as pd
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardBase
 from ax.analysis.plotly.color_constants import AX_BLUE
 
 from ax.analysis.plotly.plotly_analysis import (
@@ -35,6 +34,7 @@
     validate_adapter_can_predict,
     validate_experiment,
 )
+from ax.core.analysis_card import AnalysisCardBase
 from ax.core.experiment import Experiment
 from ax.core.parameter import DerivedParameter
 from ax.core.trial_status import STATUSES_EXPECTING_DATA
diff --git a/ax/analysis/plotly/top_surfaces.py b/ax/analysis/plotly/top_surfaces.py
@@ -10,12 +10,6 @@
 from ax.adapter.base import Adapter
 from ax.adapter.torch import TorchAdapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import (
-    AnalysisCard,
-    AnalysisCardBase,
-    AnalysisCardGroup,
-    ErrorAnalysisCard,
-)
 from ax.analysis.plotly.plotly_analysis import PlotlyAnalysisCard
 from ax.analysis.plotly.sensitivity import SensitivityAnalysisPlot
 from ax.analysis.plotly.surface.contour import (
@@ -34,6 +28,12 @@
     validate_experiment,
     validate_experiment_has_trials,
 )
+from ax.core.analysis_card import (
+    AnalysisCard,
+    AnalysisCardBase,
+    AnalysisCardGroup,
+    ErrorAnalysisCard,
+)
 from ax.core.experiment import Experiment
 from ax.exceptions.core import UserInputError
 from ax.generation_strategy.generation_strategy import GenerationStrategy
diff --git a/ax/analysis/results.py b/ax/analysis/results.py
@@ -10,7 +10,6 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.best_trials import BestTrials
 from ax.analysis.plotly.arm_effects import ArmEffectsPlot
 from ax.analysis.plotly.bandit_rollout import BanditRollout
@@ -21,6 +20,7 @@
 )
 from ax.analysis.summary import Summary
 from ax.analysis.utils import extract_relevant_adapter, validate_experiment
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.core.arm import Arm
 from ax.core.batch_trial import BatchTrial
 from ax.core.experiment import Experiment
diff --git a/ax/analysis/search_space_summary.py b/ax/analysis/search_space_summary.py
@@ -10,9 +10,9 @@
 from ax.adapter.base import Adapter
 
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard
 
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCard
 from ax.core.experiment import Experiment
 from ax.exceptions.core import UserInputError
 from ax.generation_strategy.generation_strategy import GenerationStrategy
diff --git a/ax/analysis/summary.py b/ax/analysis/summary.py
@@ -11,8 +11,8 @@
 from ax.adapter.base import Adapter
 
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCard
 from ax.analysis.utils import validate_experiment
+from ax.core.analysis_card import AnalysisCard
 from ax.core.experiment import Experiment
 from ax.core.map_data import MapData
 from ax.core.trial_status import NON_STALE_STATUSES, TrialStatus
diff --git a/ax/analysis/tests/test_overview.py b/ax/analysis/tests/test_overview.py
@@ -12,13 +12,13 @@
 import pandas as pd
 from ax.adapter.base import Adapter
 from ax.adapter.registry import Generators
-from ax.analysis.analysis_card import ErrorAnalysisCard
 from ax.analysis.overview import OverviewAnalysis
 from ax.analysis.plotly.arm_effects import ArmEffectsPlot
 from ax.analysis.plotly.scatter import ScatterPlot
 from ax.analysis.results import ResultsAnalysis
 from ax.api.client import Client
 from ax.api.configs import RangeParameterConfig
+from ax.core.analysis_card import ErrorAnalysisCard
 from ax.core.arm import Arm
 from ax.core.data import Data
 from ax.core.experiment import Experiment
diff --git a/ax/analysis/tests/test_results.py b/ax/analysis/tests/test_results.py
@@ -7,10 +7,10 @@
 
 import pandas as pd
 from ax.adapter.registry import Generators
-from ax.analysis.analysis_card import AnalysisCardGroup, ErrorAnalysisCard
 from ax.analysis.results import ArmEffectsPair, ResultsAnalysis
 from ax.api.client import Client
 from ax.api.configs import RangeParameterConfig
+from ax.core.analysis_card import AnalysisCardGroup, ErrorAnalysisCard
 from ax.core.arm import Arm
 from ax.core.data import Data
 from ax.core.experiment import Experiment
diff --git a/ax/analysis/trials.py b/ax/analysis/trials.py
@@ -8,10 +8,10 @@
 
 from ax.adapter.base import Adapter
 from ax.analysis.analysis import Analysis
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.plotly.arm_effects import ArmEffectsPlot
 
 from ax.analysis.utils import extract_relevant_adapter, validate_experiment
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.core.base_trial import BaseTrial
 from ax.core.batch_trial import BatchTrial
 from ax.core.experiment import Experiment
diff --git a/ax/api/client.py b/ax/api/client.py
@@ -13,7 +13,6 @@
 import numpy as np
 import pandas as pd
 from ax.analysis.analysis import Analysis, display_cards
-from ax.analysis.analysis_card import AnalysisCardBase
 from ax.analysis.overview import OverviewAnalysis
 from ax.analysis.summary import Summary
 from ax.api.configs import (
@@ -30,6 +29,7 @@
 from ax.api.utils.instantiation.from_struct import experiment_from_struct
 from ax.api.utils.storage import db_settings_from_storage_config
 from ax.api.utils.structs import ExperimentStruct, GenerationStrategyDispatchStruct
+from ax.core.analysis_card import AnalysisCardBase
 from ax.core.experiment import Experiment
 from ax.core.metric import Metric
 from ax.core.objective import MultiObjective, Objective, ScalarizedObjective
diff --git a/ax/api/tests/test_client.py b/ax/api/tests/test_client.py
@@ -12,7 +12,6 @@
 
 import numpy as np
 import pandas as pd
-from ax.analysis.analysis_card import AnalysisCard
 from ax.analysis.plotly.parallel_coordinates import ParallelCoordinatesPlot
 from ax.api.client import Client
 from ax.api.configs import (
@@ -24,6 +23,7 @@
 from ax.api.protocols.metric import IMetric
 from ax.api.protocols.runner import IRunner
 from ax.api.types import TParameterization
+from ax.core.analysis_card import AnalysisCard
 from ax.core.evaluations_to_data import DataType
 from ax.core.experiment import Experiment
 from ax.core.map_data import MapData
diff --git a/ax/core/analysis_card.py b/ax/core/analysis_card.py
diff --git a/ax/core/tests/test_analysis_card.py b/ax/core/tests/test_analysis_card.py
@@ -7,9 +7,9 @@
 
 import pandas as pd
 from ax.analysis.analysis import AnalysisCard
-from ax.analysis.analysis_card import AnalysisCardGroup
 from ax.analysis.markdown.markdown_analysis import MarkdownAnalysisCard
 from ax.analysis.plotly.plotly_analysis import PlotlyAnalysisCard
+from ax.core.analysis_card import AnalysisCardGroup
 from ax.utils.common.testutils import TestCase
 from plotly import graph_objects as go, io as pio
 
diff --git a/ax/service/utils/analysis_base.py b/ax/service/utils/analysis_base.py
@@ -8,8 +8,8 @@
 from collections.abc import Iterable
 
 from ax.analysis.analysis import Analysis, display_cards
-from ax.analysis.analysis_card import AnalysisCardBase
 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.service.utils.with_db_settings_base import WithDBSettingsBase
diff --git a/ax/service/utils/with_db_settings_base.py b/ax/service/utils/with_db_settings_base.py
@@ -11,7 +11,7 @@
 from collections.abc import Sequence
 from logging import INFO, Logger
 
-from ax.analysis.analysis_card import AnalysisCardBase
+from ax.core.analysis_card import AnalysisCardBase
 from ax.core.base_trial import BaseTrial
 from ax.core.experiment import Experiment
 from ax.core.generator_run import GeneratorRun
diff --git a/ax/storage/sqa_store/decoder.py b/ax/storage/sqa_store/decoder.py
@@ -14,15 +14,15 @@
 from typing import Any, Callable, cast, Union
 
 import pandas as pd
-from ax.analysis.analysis_card import (
+from ax.analysis.healthcheck.healthcheck_analysis import HealthcheckAnalysisCard
+from ax.analysis.markdown.markdown_analysis import MarkdownAnalysisCard
+from ax.analysis.plotly.plotly_analysis import PlotlyAnalysisCard
+from ax.core.analysis_card import (
     AnalysisCard,
     AnalysisCardBase,
     AnalysisCardGroup,
     ErrorAnalysisCard,
 )
-from ax.analysis.healthcheck.healthcheck_analysis import HealthcheckAnalysisCard
-from ax.analysis.markdown.markdown_analysis import MarkdownAnalysisCard
-from ax.analysis.plotly.plotly_analysis import PlotlyAnalysisCard
 from ax.core.arm import Arm
 from ax.core.auxiliary import AuxiliaryExperiment, AuxiliaryExperimentPurpose
 from ax.core.base_trial import BaseTrial
diff --git a/ax/storage/sqa_store/encoder.py b/ax/storage/sqa_store/encoder.py
diff --git a/ax/storage/sqa_store/load.py b/ax/storage/sqa_store/load.py
diff --git a/ax/storage/sqa_store/save.py b/ax/storage/sqa_store/save.py
diff --git a/ax/storage/sqa_store/tests/test_sqa_store.py b/ax/storage/sqa_store/tests/test_sqa_store.py
