Add documentation link to the built-in packages

optuna · May 22, 2024 · e19a716 · e19a716
1 parent b26502e
commit e19a716
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 0 deletions.
diff --git a/package/visualization/plot_contour/README.md b/package/visualization/plot_contour/README.md
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_contour")
 mod.plot_contour(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_edf")
 mod.plot_edf(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_hypervolume_history")
 mod.plot_hypervolume_history(study, reference_point)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_intermediate_values")
 mod.plot_intermediate_values(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_optimization_history")
 mod.plot_optimization_history(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_parallel_coordinate")
 mod.plot_parallel_coordinate(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_param_importances")
 mod.plot_param_importances(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_pareto_front")
 mod.plot_pareto_front(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_rank")
 mod.plot_rank(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_slice")
 mod.plot_slice(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_terminator_improvement")
 mod.plot_terminator_improvement(study)
 ```
+
+## 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
@@ -15,3 +15,6 @@ license: 'MIT License'
 mod = optunahub.load_module("visualization/plot_timeline")
 mod.plot_timeline(study)
 ```
+
+## Others
+See the [documentation](https://optuna.readthedocs.io/en/stable/reference/visualization/generated/optuna.visualization.plot_timeline.html) for more details.