Improvements to Training-ML-Agents #3776
Merged
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
- Removed duplicate documentation - Moved CLI descriptions to learn.py - Reorganized "Training with mlagents-learn" into 5 sub-sections
chriselion
reviewed
Apr 14, 2020
ml-agents/mlagents/trainers/learn.py
Outdated
| help="The starting port for environment communication. Each concurrent Unity environment " | ||
| "instance will get assigned a port sequentially, starting from the base-port. Each instance " | ||
| "will use the port (base_port + worker_id), where the worker_id is sequential IDs given to " | ||
| "each instance from 0 to (num_envs - 1). Note that When training using the Editor rather " |
There was a problem hiding this comment.
Suggested change
| "each instance from 0 to (num_envs - 1). Note that When training using the Editor rather " | |
| "each instance from 0 to (num_envs - 1). Note that when training using the Editor rather " |
chriselion
approved these changes
Apr 14, 2020
|
@ervteng - @chriselion has already reviewed/approved but wanted a quick pass from you. |
ervteng
reviewed
Apr 14, 2020
docs/Training-ML-Agents.md
Outdated
| **Note:** The default port TensorBoard uses is 6006. If there is an existing session | ||
| running on port 6006 a new session can be launched on an open port using the --port | ||
| option. | ||
| If you enable the `--debug` flag in the command line, the trainer metrics are logged to a CSV file |
There was a problem hiding this comment.
Unfortunately none of these things are correct anymore, I think we can just remove the whole Debugging section.
The CSV is still created under the summaries/ directory, but is slated to be deprecated and replaced with a JSON file, so it's probably OK if we don't mention it.
There was a problem hiding this comment.
So should we remove now and bring back once we add the JSON file?
There was a problem hiding this comment.
And also, remove the --debug option from the CLI?
There was a problem hiding this comment.
+1 for remove now and bring back once we add the JSON file.
The --debug CLI option is still there, but it doesn't really help the user in debugging training (it's mostly for us), nor does it log the CSV. So it probably doesn't go in this doc. Is it OK if we just leave it to the --help menu to describe?
ervteng
reviewed
Apr 15, 2020
added 8 commits
April 14, 2020 19:18
Will update the UIE page in a separate PR.
commit 9600d0f Author: Marwan Mattar <marwan@unity3d.com> Date: Tue Apr 14 17:45:33 2020 -0700 Various doc improvements (#3775) * Various doc improvements For Using-Virtual-Environment.md: - Made a note regarding updating setuptools and pip. - Changed lists from "-" to "*" For Using-Tensorboard.md: - Changed the ordered list to use "1." For Training-on-Microsoft-Azure-Custom-Instance.md: - Deleted as it was not linked anywhere For FAQ.md - Removed stale issues given upgrade to 2018.3 For Readme.md - Added links for Reward Signals, Self-Play and Profiling Trainers For Learning-Environment-Executable.md - Changed the ordered list to use "1." For Learning-Environment-Examples.md - Minor rewording of intro paragraphs * consolidating custom instances page in main page So we have a single page for Azure. Adding warning note for deprecated docs * Fixing doc links that are failing CI commit 34db9c2 Author: Vincent-Pierre BERGES <vincentpierre@unity3d.com> Date: Tue Apr 14 14:06:16 2020 -0700 Removing dark mode from screenshots (#3772) commit 1e164cc Author: Chris Elion <chris.elion@unity3d.com> Date: Tue Apr 14 13:08:18 2020 -0700 [MLA-488] Fix observations in demonstration drawer (#3771) * WIP observation shapes * WIP observation shapes * fix Observation shape serialization * rename field, redo screenshot * docstring * changelog
This reverts commit 819e8d5.
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)
Describe the changes made in this PR.
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
Types of change(s)
Checklist
Other comments