This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
[docs] Move a bunch of short options to long options. #3385
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
klshuster
approved these changes
Jan 15, 2021
docs/source/tutorial_basic.md
Outdated
| @@ -364,34 +364,34 @@ Here are some examples: | |||
|
|
|||
| ```python | |||
| # Train a seq2seq model on the "10k training examples" bAbI task 1 with batch size of 32 examples until accuracy reaches 95% on validation (requires pytorch): | |||
| parlai train_model -t babi:task10k:1 -m seq2seq -mf /tmp/model_s2s -bs 32 -vtim 30 -vcut 0.95 | |||
| parlai train_model --task babi:task10k:1 --model seq2seq --model-file /tmp/model_s2s --batchsize 32 --validation-every-n-secs 30 -vcut 0.95 | |||
There was a problem hiding this comment.
--validation-cutoff (didn't even know this was an option)
| ``` | ||
|
|
||
| Now, we'll train the model. This will take a while to reach convergence. | ||
|
|
||
| ```bash | ||
| # train transformer ranker | ||
| parlai train_model -t twitter -mf /tmp/tr_twitter -m transformer/ranker -bs 16 -vtim 3600 -cands batch -ecands batch --data-parallel True | ||
| parlai train_model --task twitter --model-file /tmp/tr_twitter --model transformer/ranker --batchsize 16 --validation-every-n-secs 3600 --candidates batch --eval-candidates batch --data-parallel True |
There was a problem hiding this comment.
validation-every-n-secs is too long. I know this is the doc, but is that possible to change that into something like validation-freq
There was a problem hiding this comment.
that's a valid point (no pun intended) but the issue is that we have several (and soon to be more) ways of defining "frequency" (epochs, seconds, soon-to-be training steps).
perhaps we can change them all to --validation-freq-secs, --validation-freq-steps, --validation-freq-epochs
There was a problem hiding this comment.
I'm hesitant to change the names of options that have been around 3 years :/
mojtaba-komeili
approved these changes
Jan 16, 2021
stephenroller
added a commit
that referenced
this pull request
Feb 11, 2021
* Move a bunch of short options to long options. * Move some options in docstrings. * A few missed things.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Patch description
Global string replaces mostly, so some things may still be missing.
Still TODO: docstrings in parlai/scripts
Testing steps
CI render of website