Skip to content

Commit cb53808

Browse files
committed
Add description for how to use automatic chart generation feature
1 parent 34365a8 commit cb53808

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

optuna_dashboard/llm/_api_views.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def get_generate_plotly_graph_func_str() -> dict[str, str]:
8686
except Exception as e:
8787
response.status = 500
8888
return {"reason": str(e)}
89-
89+
9090
try:
9191
# TODO(c-bata): Consider removing the generate_plotly_graph_func_str argument
9292
# to enable parallel llm provider calls

optuna_dashboard/ts/components/StudyDetail.tsx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
import ChevronRightIcon from "@mui/icons-material/ChevronRight"
22
import HomeIcon from "@mui/icons-material/Home"
33
import {
4+
Alert,
45
Box,
56
Card,
67
CardContent,
78
IconButton,
9+
Link as MuiLink,
810
Typography,
911
useTheme,
1012
} from "@mui/material"
@@ -150,6 +152,19 @@ export const StudyDetail: FC<{
150152
>
151153
Graph Generated by LLM
152154
</Typography>
155+
<Alert severity="info" sx={{ m: theme.spacing(0, 2) }}>
156+
This feature enables the LLM to create Plotly charts based on
157+
natural language descriptions, helping you visualize study results
158+
interactively. For more details, please refer to{" "}
159+
<MuiLink
160+
href="https://optuna-dashboard.readthedocs.io/en/latest/tutorials/llm-integration.html#automatic-plotly-charts-generation"
161+
target="_blank"
162+
color="inherit"
163+
>
164+
the documentation
165+
</MuiLink>
166+
.
167+
</Alert>
153168
<GraphByLLM study={studyDetail} />
154169
</>
155170
)}

0 commit comments

Comments
 (0)