Merge pull request #1176 from c-bata/follow-up-plotly-graph

Follow-up #1171: Add some improvements on automatic plotly chart generation

Author: c-bata

optuna_dashboard/llm/_api_views.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from typing import TYPE_CHECKING
 
 from bottle import Bottle
@@ -19,6 +20,9 @@
     from .llm.provider import LLMProvider
 
 
+_logger = logging.getLogger(__name__)
+
+
 def register_llm_route(app: Bottle, llm_provider: LLMProvider | None) -> None:
     @app.post("/api/llm/trial_filter_query")
     @json_api_view
@@ -71,10 +75,6 @@ def get_generate_plotly_graph_func_str() -> dict[str, str]:
         try:
             prompt_for_func = get_generate_plotly_graph_prompt(user_query, func_str, err_msg)
             generate_plotly_graph_func_str = llm_provider.call(prompt_for_func)
-            prompt_for_title = get_generate_plotly_graph_title_prompt(
-                user_query, generate_plotly_graph_func_str
-            )
-            generated_plotly_graph_title = llm_provider.call(prompt_for_title)
         except RateLimitExceeded as e:
             response.status = 429  # Too Many Requests
             reason = f"Rate limit exceeded. Try again later. The actual error: {str(e)}"
@@ -87,6 +87,17 @@ def get_generate_plotly_graph_func_str() -> dict[str, str]:
             response.status = 500
             return {"reason": str(e)}
 
+        try:
+            # TODO(c-bata): Consider removing the generate_plotly_graph_func_str argument
+            # to enable parallel llm provider calls
+            prompt_for_title = get_generate_plotly_graph_title_prompt(
+                user_query, generate_plotly_graph_func_str
+            )
+            generated_plotly_graph_title = llm_provider.call(prompt_for_title)
+        except Exception as e:
+            _logger.error("Failed to generate title for plotly graph: %s", e)
+            generated_plotly_graph_title = f'Graph generated by "{user_query}"'
+
         response.status = 200
         return {
             "generate_plotly_graph_func_str": generate_plotly_graph_func_str,

optuna_dashboard/ts/components/StudyDetail.tsx

@@ -1,10 +1,12 @@
 import ChevronRightIcon from "@mui/icons-material/ChevronRight"
 import HomeIcon from "@mui/icons-material/Home"
 import {
+  Alert,
   Box,
   Card,
   CardContent,
   IconButton,
+  Link as MuiLink,
   Typography,
   useTheme,
 } from "@mui/material"
@@ -150,6 +152,19 @@ export const StudyDetail: FC<{
             >
               Graph Generated by LLM
             </Typography>
+            <Alert severity="info" sx={{ m: theme.spacing(0, 2) }}>
+              This feature enables the LLM to create Plotly charts based on
+              natural language descriptions, helping you visualize study results
+              interactively. For more details, please refer to{" "}
+              <MuiLink
+                href="https://optuna-dashboard.readthedocs.io/en/latest/tutorials/llm-integration.html#automatic-plotly-charts-generation"
+                target="_blank"
+                color="inherit"
+              >
+                the documentation
+              </MuiLink>
+              .
+            </Alert>
             <GraphByLLM study={studyDetail} />
           </>
         )}