Skip to content

Commit

Permalink
Update docs and template
Browse files Browse the repository at this point in the history
  • Loading branch information
y0z committed Jul 5, 2024
1 parent 67d7456 commit 4e3f756
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion recipes/002_registration.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
- `author`: The author of the package. It can be your name or your organization name.
- `title`: The package title. It should not be a class/function name but a human-readable name. For example, `Demo Sampler` is a good title, but `DemoSampler` is not.
- `description`: A brief description of the package. It should be a one-sentence summary of the package.
- `tags`: The package tags. It should be a list of strings. The tags must include `sampler` or `visualization` depending on the type of the package. You can add other tags as needed. For example, "['sampler', 'LLM']".
- `tags`: The package tags. It should be a list of strings. The tags must include `sampler`, `visualization`, or `pruner` depending on the type of the package. You can add other tags as needed. For example, "['sampler', 'LLM']".
- `optuna_versions`: A list of Optuna versions that the package supports. It should be a list of strings. For example, "['3.5.0', '3.6.1']".
- `license`: The license of the package. It should be a string. For example, `'MIT License'`. The license must be `MIT License` in the current version of OptunaHub.
Expand Down
5 changes: 5 additions & 0 deletions template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ This is an example of the frontmatters.
All columns must be string.
You can omit quotes when value types are not ambiguous.
However, quotes are required in ambiguous cases, e.g., '3.5' must not be 3.5.
For tags, a package placed in
- package/samplers/ must include the tag "sampler"
- package/visualilzation/ must include the tag "visualization"
- package/pruners/ must include the tag "pruner"
respectively.
---
author: Optuna team
Expand Down

0 comments on commit 4e3f756

Please sign in to comment.