Source code for ax.analysis.plotly.plotly_analysis

# 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


import pandas as pd
from ax.analysis.analysis import Analysis, AnalysisCard
from ax.core.experiment import Experiment
from ax.core.generation_strategy_interface import GenerationStrategyInterface
from IPython.display import display, Markdown
from plotly import graph_objects as go, io as pio



[docs]
class PlotlyAnalysisCard(AnalysisCard):
    blob_annotation = "plotly"


[docs]
    def get_figure(self) -> go.Figure:
        return pio.from_json(self.blob)


    def _ipython_display_(self) -> None:
        """
        IPython display hook. This is called when the AnalysisCard is printed in an
        IPython environment (ex. Jupyter). Here we want to display the Plotly figure.
        """
        display(Markdown(f"## {self.title}\n\n### {self.subtitle}"))
        display(self.get_figure())




[docs]
class PlotlyAnalysis(Analysis):
    """
    An Analysis that computes a Plotly figure.
    """


[docs]
    def compute(

        self,
        experiment: Experiment | None = None,
        generation_strategy: GenerationStrategyInterface | None = None,
    ) -> PlotlyAnalysisCard: ...

    def _create_plotly_analysis_card(
        self,
        title: str,
        subtitle: str,
        level: int,
        df: pd.DataFrame,
        fig: go.Figure,
    ) -> PlotlyAnalysisCard:
        """
        Make a PlotlyAnalysisCard from this Analysis using provided fields and
        details about the Analysis class.
        """
        return PlotlyAnalysisCard(
            name=self.name,
            attributes=self.attributes,
            title=title,
            subtitle=subtitle,
            level=level,
            df=df,
            blob=pio.to_json(fig),
        )