Improve notebook display of AnalysisCards (#2899)

Summary:
Pull Request resolved: #2899

Display title and subtitle, and sort cards by level in display_cards. Useful for using with AxClient in a notebook.

Also add minimum_priority argument to display_cards, by default show everything but debug

Reviewed By: danielcohenlive

Differential Revision: D64495780

fbshipit-source-id: 816f0f7735b7228a14b3713ab4bfa6a45e64dd36

ax/analysis/analysis.py

@@ -16,7 +16,7 @@
 from ax.utils.common.base import Base
 from ax.utils.common.logger import get_logger
 from ax.utils.common.result import Err, ExceptionE, Ok, Result
-from IPython.display import display
+from IPython.display import display, Markdown
 
 logger: Logger = get_logger(__name__)
 
@@ -79,15 +79,23 @@ def _ipython_display_(self) -> None:
 
         By default, this method displays the raw data in a pandas DataFrame.
         """
+        display(Markdown(f"## {self.title}\n\n### {self.subtitle}"))
         display(self.df)
 
 
-def display_cards(cards: Iterable[AnalysisCard]) -> None:
+def display_cards(
+    cards: Iterable[AnalysisCard], minimum_level: int = AnalysisCardLevel.LOW
+) -> None:
     """
     Display a collection of AnalysisCards in IPython environments (ex. Jupyter).
+
+    Args:
+        cards: Collection of AnalysisCards to display.
+        minimum_level: Minimum level of cards to display.
     """
-    for card in cards:
-        display(card)
+    for card in sorted(cards, key=lambda x: x.level, reverse=True):
+        if card.level >= minimum_level:
+            display(card)
 
 
 class Analysis(Protocol):

ax/analysis/markdown/markdown_analysis.py

@@ -24,7 +24,7 @@ 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 render the Markdown.
         """
-        display(Markdown(self.blob))
+        display(Markdown(f"## {self.title}\n\n### {self.subtitle}\n\n{self.blob}"))
 
 
 class MarkdownAnalysis(Analysis):

ax/analysis/plotly/plotly_analysis.py

@@ -10,7 +10,7 @@
 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
+from IPython.display import display, Markdown
 from plotly import graph_objects as go, io as pio
 
 
@@ -25,6 +25,7 @@ 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())