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

Update README.md #30

Merged
merged 1 commit into from
Jan 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions experiments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ python -m experiments --help

# Setup
- Please edit params.py with the appropriate params for your experiments.
- She's a bit hacky. >_<
- Algorithm keys can include suffixes separated by an underscore. So `lr_test` is a valid key for `lr`.
- And suffixed algorithms inherit and override params from the algorithm dict. So `lr_test` gets all of `lr` params.
- Try using the `make` CLI command and examining the params file if you want to check what's going on.
- System and algorithm keys should be specified in keys.py

# Commands
Expand Down