From 3dc869dcf6b8c1a9266a5f74740f4f8e0dedba78 Mon Sep 17 00:00:00 2001 From: y0z Date: Mon, 29 Jul 2024 17:58:38 +0900 Subject: [PATCH] Update --- recipes/002_registration.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/recipes/002_registration.py b/recipes/002_registration.py index 7c4a3cd0..f69ecb47 100644 --- a/recipes/002_registration.py +++ b/recipes/002_registration.py @@ -22,7 +22,7 @@ | ├── (requirements.txt) | └── (images) | ├── (figure1.png) -| └── (figure2.png) +| └── (numerical_results.png) An implemented algorithm should be put in the corresponding directory, e.g., a sampler should be put in the `samplers` directory. In the `samplers` directory, you should create a directory with a unique identifier. @@ -38,7 +38,7 @@ - `LICENSE`: A license file. This file must contain the license of your algorithm. It should be the MIT license in the alpha version of OptunaHub. - `example.py`: This is optional. This file should contain a simple example of how to use your algorithm (Example: `example.py for Simulated Annealing Sampler `_). - `requirements.txt`: This is optional. A file that contains the additional dependencies of your algorithm. If there are no additional dependencies other than Optuna and OptunaHub, you do not need to create this file. -- `images`: This is optional. A directory that contains images. Only relative references to images in this directory are allowed in README.md, e.g., ``![Numrical Results](images/figure1.png)``, and absolute paths to images are not allowed. The first image that appears in README.md will be used as the thumbnail. +- `images`: This is optional. A directory that contains images. Only relative references to images in this directory are allowed in README.md, e.g., ``![Numrical Results](images/numerical_results.png)``, and absolute paths to images are not allowed. The first image that appears in README.md will be used as the thumbnail. All files must pass linter and formetter checks to be merged to the optunahub-registry repository. You can check them by running the `pre-commit `__ tool as follows.