From 29261704dbb6adc0e46a13991d41d207fad15d20 Mon Sep 17 00:00:00 2001 From: mamu Date: Wed, 15 May 2024 18:40:27 +0900 Subject: [PATCH] Add explanation about figures --- .../plot_hypervolume_history_with_rp/README.md | 2 +- .../{img => images}/example.png | Bin .../{img => images}/thumbnail.png | Bin recipes/001_first.py | 4 ++++ 4 files changed, 5 insertions(+), 1 deletion(-) rename package/visualization/plot_hypervolume_history_with_rp/{img => images}/example.png (100%) rename package/visualization/plot_hypervolume_history_with_rp/{img => images}/thumbnail.png (100%) diff --git a/package/visualization/plot_hypervolume_history_with_rp/README.md b/package/visualization/plot_hypervolume_history_with_rp/README.md index 3b9daade..03f2adbf 100644 --- a/package/visualization/plot_hypervolume_history_with_rp/README.md +++ b/package/visualization/plot_hypervolume_history_with_rp/README.md @@ -63,7 +63,7 @@ if __name__ == "__main__": fig.show() ``` -![Example](img/example.png "Example") +![Example](images/example.png "Example") # Author Information diff --git a/package/visualization/plot_hypervolume_history_with_rp/img/example.png b/package/visualization/plot_hypervolume_history_with_rp/images/example.png similarity index 100% rename from package/visualization/plot_hypervolume_history_with_rp/img/example.png rename to package/visualization/plot_hypervolume_history_with_rp/images/example.png diff --git a/package/visualization/plot_hypervolume_history_with_rp/img/thumbnail.png b/package/visualization/plot_hypervolume_history_with_rp/images/thumbnail.png similarity index 100% rename from package/visualization/plot_hypervolume_history_with_rp/img/thumbnail.png rename to package/visualization/plot_hypervolume_history_with_rp/images/thumbnail.png diff --git a/recipes/001_first.py b/recipes/001_first.py index 7a142f4b..9e29a477 100644 --- a/recipes/001_first.py +++ b/recipes/001_first.py @@ -122,6 +122,9 @@ def objective(trial: optuna.trial.Trial) -> float: # | ├── README.md # | ├── __init__.py # | ├── LICENSE +# | ├── images +# | │ ├── thumbnail.png +# | │ └── screenshot.png # | └── YOUR_ALGORITHM_NAME.py # # If you implement not visualizarion feature but sampler, you should put your implementation in the `samplers` directory. @@ -131,6 +134,7 @@ def objective(trial: optuna.trial.Trial) -> float: # - `README.md`: A description of your algorithm. This file is used to create an `web page of OptunaHub `_. Let me explain the format of the `README.md` file later. # - `__init__.py`: An initialization file. This file must import your impelemented sampler from `YOUR_ALGORITHM_NAME.py`. # - `LICENSE`: A license file. This file must contain the license of your algorithm. It should be the MIT license in the alpha version. +# - `images`: This is optional. A directory that contains images. You can put images that are used in the `web page of OptunaHub `_. Note that the image file named `thumbnail.png` is used as a thumbnail in the web page. If you want to put other images like `screenshot.png` and use them in the `README.md` file, please use the relative path like `images/screenshot.png`. # - `YOUR_ALGORITHM_NAME.py`: Your implemented sampler. # # The `README.md` file must contain the following sections: