Merge pull request #72 from y0z/feature/add-images-to-visualization

Add images to visualization packages
optuna · Jun 20, 2024 · 586a27c · 586a27c
2 parents 7452975 + 9f8db5e
commit 586a27c
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 0 deletions.
diff --git a/package/visualization/plot_contour/README.md b/package/visualization/plot_contour/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_contour
 plot_contour(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_contour.html) for more details.
diff --git a/package/visualization/plot_edf/README.md b/package/visualization/plot_edf/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_edf
 plot_edf(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_edf.html) for more details.
diff --git a/package/visualization/plot_hypervolume_history/README.md b/package/visualization/plot_hypervolume_history/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_hypervolume_history
 plot_hypervolume_history(study, reference_point)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_hypervolume_history.html) for more details.
diff --git a/package/visualization/plot_intermediate_values/README.md b/package/visualization/plot_intermediate_values/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_intermediate_values
 plot_intermediate_values(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_intermediate_values.html) for more details.
diff --git a/package/visualization/plot_optimization_history/README.md b/package/visualization/plot_optimization_history/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_optimization_history
 plot_optimization_history(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_optimization_history.html) for more details.
diff --git a/package/visualization/plot_parallel_coordinate/README.md b/package/visualization/plot_parallel_coordinate/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_parallel_coordinate
 plot_parallel_coordinate(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_parallel_coordinate.html) for more details.
diff --git a/package/visualization/plot_param_importances/README.md b/package/visualization/plot_param_importances/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_param_importances
 plot_param_importances(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_param_importances.html) for more details.
diff --git a/package/visualization/plot_pareto_front/README.md b/package/visualization/plot_pareto_front/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_pareto_front
 plot_pareto_front(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_pareto_front.html) for more details.
diff --git a/package/visualization/plot_rank/README.md b/package/visualization/plot_rank/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_rank
 plot_rank(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_rank.html) for more details.
diff --git a/package/visualization/plot_slice/README.md b/package/visualization/plot_slice/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_slice
 plot_slice(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_slice.html) for more details.
diff --git a/package/visualization/plot_terminator_improvement/README.md b/package/visualization/plot_terminator_improvement/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_terminator_improvement
 plot_terminator_improvement(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_terminator_improvement.html) for more details.
diff --git a/package/visualization/plot_timeline/README.md b/package/visualization/plot_timeline/README.md
@@ -16,5 +16,7 @@ from optuna.visualization import plot_timeline
 plot_timeline(study)
 ```
 
+![Example](images/thumbnail.png "Example")
+
 ## Others
 See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_timeline.html) for more details.