Enable to download a csv file

optuna_dashboard/_app.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
+import csv
 import functools
+import io
 import logging
 import os
 import typing
@@ -152,7 +154,7 @@
                 storage=storage, study_name=dst_study_name, directions=src_study.directions
             )
             dst_study.add_trials(src_study.get_trials(deepcopy=False))
             note.copy_notes(storage, src_study, dst_study)
         except DuplicatedStudyError:
             response.status = 400  # Bad request
             return {"reason": f"study_name={dst_study_name} is duplicaated"}
@@ -449,6 +451,60 @@
         response.status = 204  # No content
         return {}
 
+    @app.get("/csv/<study_id:int>")
+    def download_csv(study_id: int) -> BottleViewReturn:
+        # Create a CSV file
+        summary = get_study_summary(storage, study_id)
+        if summary is None:
+            response.status = 404  # Not found
+            return {"reason": f"study_id={study_id} is not found"}
+        trials = get_trials(storage, study_id)
+
+        param_names = []
+        user_attr_names = []
+        for trial in trials:
+            for param_name in trial.params.keys():
+                if param_name not in param_names:
+                    param_names.append(param_name)
+            for attr_name in trial.user_attrs.keys():
+                if attr_name not in user_attr_names:
+                    user_attr_names.append(attr_name)
+
+        param_names_heading = [f"Param {x}" for x in param_names]
+        user_attr_names_heading = [f"UserAttribute {x}" for x in user_attr_names]
+        value_heading = ["Value"]
+        if len(trials[0].values) > 1:
+            value_heading = [f"Objective {x}" for x in range(len(trials[0].values))]
+        column_names = (
+            ["Number", "State"] + value_heading + param_names_heading + user_attr_names_heading
+        )
+
+        buf = io.StringIO("")
+        writer = csv.writer(buf)
+        writer.writerow(column_names)
+        for frozen_trial in trials:
+            row = [frozen_trial.number, frozen_trial.state.name]
+            row += frozen_trial.values
+            for param_name in param_names:
+                if param_name in frozen_trial.params.keys():
+                    row += [frozen_trial.params[param_name]]
+                else:
+                    row += [None]
+            for attr_name in user_attr_names:
+                if attr_name in frozen_trial.user_attrs.keys():
+                    row += [frozen_trial.user_attrs[attr_name]]
+                else:
+                    row += [None]
+            writer.writerow(row)
+
+        # Set response headers
+        response.headers["Content-Type"] = "text/csv; chatset=cp932"
+        response.headers["Content-Disposition"] = f"attachment; filename=trials_{study_id}.csv"
+
+        # Response body
+        buf.seek(0)
+        return buf.read()
+
     @app.get("/favicon.ico")
     def favicon() -> BottleViewReturn:
         use_gzip = "gzip" in request.headers["Accept-Encoding"]

optuna_dashboard/ts/components/StudyDetail.tsx

@@ -149,11 +149,39 @@ export const StudyDetail: FC<{
     content = <TrialList studyDetail={studyDetail} />
   } else if (page === "trialTable") {
     content = (
-      <Card sx={{ margin: theme.spacing(2) }}>
-        <CardContent>
-          <TrialTable studyDetail={studyDetail} initialRowsPerPage={50} />
-        </CardContent>
-      </Card>
+      <Box sx={{ display: "flex", width: "100%", flexDirection: "column" }}>
+        <Card sx={{ margin: theme.spacing(2) }}>
+          <CardContent>
+            <TrialTable studyDetail={studyDetail} initialRowsPerPage={50} />
+          </CardContent>
+        </Card>
+        <Typography variant="h5" sx={{ margin: theme.spacing(2) }}>
+          Download CSV File
+        </Typography>{" "}
+        <Card
+          sx={{
+            margin: theme.spacing(2),
+            width: 80,
+            height: 80,
+            display: "flex",
+            justifyContent: "center",
+            alignItems: "center",
+          }}
+        >
+          <CardContent>
+            <IconButton
+              aria-label="download csv"
+              size="small"
+              color="inherit"
+              download={`trials_${studyDetail?.id}.csv`}
+              sx={{ margin: "auto 0" }}
+              href={`/csv/${studyDetail?.id}`}
+            >
+              <DownloadIcon />
+            </IconButton>
+          </CardContent>
+        </Card>
+      </Box>
     )
   } else if (page === "note" && studyDetail !== null) {
     content = (