Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
nzw0301 opened this issue Feb 12, 2024 · 1 comment
Open

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

nzw0301 opened this issue Feb 12, 2024 · 1 comment
Labels
feature Change that does not break compatibility, but affects the public interfaces of examples. stale Exempt from stale bot labeling.

Comments

@nzw0301
Copy link
Member

nzw0301 commented Feb 12, 2024

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)

@nzw0301 nzw0301 added the feature Change that does not break compatibility, but affects the public interfaces of examples. label Feb 12, 2024
Copy link

This issue has not seen any recent activity.

@github-actions github-actions bot added the stale Exempt from stale bot labeling. label Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Change that does not break compatibility, but affects the public interfaces of examples. stale Exempt from stale bot labeling.
Projects
None yet
Development

No branches or pull requests

1 participant