optuna / optuna-examples

Examples for https://github.com/optuna/optuna
MIT License
674 stars 176 forks source link

Add README to each directory if it contains multiple examples #235

Closed nzw0301 closed 3 months ago

nzw0301 commented 7 months ago

Motivation

Some directories provide multiple different examples. For instance, pytorch ditrctory propvides multiple settings with pure pytorch and pytorch's wrapper examples. Another example is terminator example. Since directories are also linked from optuna/optuna directly, the top README.md is not enough to give clear information of the directory.

Description

Add README for some complicated directory and write a short description of the usage or purpose of example files.

Alternatives (optional)

Additional context (optional)

github-actions[bot] commented 7 months ago

This issue has not seen any recent activity.

github-actions[bot] commented 3 months ago

This issue was closed automatically because it had not seen any recent activity. If you want to discuss it, you can reopen it freely.