Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
y0z committed Jul 29, 2024
1 parent ddef775 commit 3dc869d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions recipes/002_registration.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 <https://github.com/optuna/optunahub-registry/blob/main/package/samplers/simulated_annealing/example.py>`_).
- `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 <https://pre-commit.com/>`__ tool as follows.
Expand Down

0 comments on commit 3dc869d

Please sign in to comment.