Release v0.8 docs #1924
Merged
Release v0.8 docs #1924
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
…Using-Concurrent-Unity-Instances.md
xiaomaogy
reviewed
Apr 11, 2019
docs/Migrating.md
Outdated
| * If you intend to make modifications to `ml-agents` or `ml-agents-envs` please check the Installing for Development in the [Installation documentation](Installation.md). | ||
|
|
||
| #### Steps to Migrate | ||
| * Make sure to remove the `ENABLE_TENSORFLOW` flag in your Unity project settings |
There was a problem hiding this comment.
We don't need this in from v0.7 to v0.8.
|
Looks good to me aside from the comments. Remove that then merge. |
harperj
reviewed
Apr 11, 2019
docs/Training-ML-Agents.md
Outdated
| @@ -134,12 +134,11 @@ environment, you can set the following command line options when invoking | |||
| [Academy Properties](Learning-Environment-Design-Academy.md#academy-properties). | |||
| * `--train` – Specifies whether to train model or only run in inference mode. | |||
| When training, **always** use the `--train` option. | |||
| * `--num-envs` - Specifies the number of parallel environments to collect | |||
| * `--num-envs=<n>` - Specifies the number of concurrent, parallel Unity environment instances to collect | |||
There was a problem hiding this comment.
Concurrent and parallel are saying the same thing here.
harperj
reviewed
Apr 11, 2019
docs/Training-ML-Agents.md
Outdated
| environment will use the port `(base_port + worker_id)`, where the worker ID | ||
| are sequential IDs given to each environment from 0 to `num_envs - 1`. | ||
| Defaults to 5005. | ||
| * `--base-port` - Specifies the starting port for each concurrent, parallel Unity environment instance. Each instance will use the port `(base_port + worker_id)`, where the `worker_id` |
There was a problem hiding this comment.
This is a bit confusing: "the starting port for each concurrent, parallel Unity environment instance". This is the starting port from which all other ports are given sequential port numbers. Not the starting port for each.
harperj
approved these changes
Apr 11, 2019
|
Couple of comments, but no show stoppers |
|
@unityjeffrey Can I squash and merge this? |
LeSphax
pushed a commit
to LeSphax/ml-agents-1
that referenced
this pull request
May 3, 2020
* update title caps * Rename Custom-Protos.md to Creating-Custom-Protobuf-Messages.md * Updated with custom protobuf messages * Cleanup against to our doc guidelines * Minor text revision * Create Training-Concurrent-Unity-Instances * Rename Training-Concurrent-Unity-Instances to Training-Concurrent-Unity-Instances.md * update to right format for --num-envs * added link to concurrent unity instances * Update and rename Training-Concurrent-Unity-Instances.md to Training-Using-Concurrent-Unity-Instances.md * Added considerations section * Update Training-Using-Concurrent-Unity-Instances.md * cleaned up language to match doc * minor updates * retroactive migration from 0.6 to 0.7 * Updated from 0.7 to 0.8 migration * Minor typo * minor fix * accidentally duplicated step * updated with new features list
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.
Doc review.