From ad47b1f8f76511777a2fa0e594313726d8db8150 Mon Sep 17 00:00:00 2001 From: mamu Date: Wed, 15 May 2024 18:43:55 +0900 Subject: [PATCH] Add instruction to use requirements.txt --- recipes/001_first.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/recipes/001_first.py b/recipes/001_first.py index 9e29a477..467b53c4 100644 --- a/recipes/001_first.py +++ b/recipes/001_first.py @@ -125,6 +125,7 @@ def objective(trial: optuna.trial.Trial) -> float: # | ├── images # | │ ├── thumbnail.png # | │ └── screenshot.png +# | ├── requirements.txt # | └── YOUR_ALGORITHM_NAME.py # # If you implement not visualizarion feature but sampler, you should put your implementation in the `samplers` directory. @@ -135,6 +136,7 @@ def objective(trial: optuna.trial.Trial) -> float: # - `__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`. +# - `requirements.txt`: This is optional. A file that contains the additional dependencies of your algorithm. If there are no additional dependencies, you do not need to create this file. # - `YOUR_ALGORITHM_NAME.py`: Your implemented sampler. # # The `README.md` file must contain the following sections: