[docs] Update docs for new results and trainer config #3916
Conversation
This file contains hidden or 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
ervteng
commented
May 1, 2020
docs/Training-ML-Agents.md
Outdated
|
|
||
| The implementation of the samplers can be found at | ||
| `ml-agents-envs/mlagents_envs/sampler_class.py`. | ||
| `ml-agents/mlagents/trainers/sampler_class.py`. |
Contributor
Author
There was a problem hiding this comment.
Note: this is likely wrong in the release docs as well.
Contributor
There was a problem hiding this comment.
Can you link to the file so that we get some automated checks on it?
ervteng
commented
May 1, 2020
| the --port option. | ||
|
|
||
| **Note:** If you don't assign a `run-id` identifier, `mlagents-learn` uses the | ||
| default string, "ppo". All the statistics will be saved to the same sub-folder |
Contributor
Author
There was a problem hiding this comment.
This was also missed in the release docs - the new behavior is that it will delete old summaries if run with --force
Contributor
Author
|
There were two fairly small things that I noticed could be wrong in the release docs as well. I'll PR those in into |
chriselion
reviewed
May 1, 2020
chriselion
approved these changes
May 1, 2020
Co-authored-by: Chris Elion <[email protected]>
…echnologies/ml-agents into develop-doc-updates-after-1merge
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.
Proposed change(s)
Recent PRs merged the curriculum and parameter randomization YAML files into the main configuration, and moved all artifacts to a single
results/directory. These doc changes weren't reflected in the refactored release docs. This PR ports those changes over to the new doc format.Types of change(s)
Checklist
Other comments