Skip to content

Commit

Permalink
Merge pull request #17 from optuna/add-instruction-to-requirements=txt
Browse files Browse the repository at this point in the history
Add instruction to use requirements.txt
  • Loading branch information
HideakiImamura authored May 15, 2024
2 parents 14990e9 + ad47b1f commit e6bef7b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions recipes/001_first.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 <TBD>`_. 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:
Expand Down

0 comments on commit e6bef7b

Please sign in to comment.