Docs ll api #3047
Merged
Docs ll api #3047
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
Co-Authored-By: Chris Elion <chris.elion@unity3d.com>
chriselion
reviewed
Dec 9, 2019
chriselion
approved these changes
Dec 9, 2019
Co-Authored-By: Chris Elion <chris.elion@unity3d.com>
ervteng
reviewed
Dec 9, 2019
|
|
||
| The `mlagents` Python package contains two components: a low level API which | ||
| allows you to interact directly with a Unity Environment (`mlagents.envs`) and | ||
| an entry point to train (`mlagents-learn`) which allows you to train agents in | ||
| Unity Environments using our implementations of reinforcement learning or | ||
| imitation learning. | ||
|
|
||
| You can use the Python Low Level API to interact directly with your learning | ||
| environment, and use it to develop new learning algorithms |
There was a problem hiding this comment.
period after algorithms, maybe add develop new learning algorithms for them. (not sure about this)
vincentpierre
added a commit
that referenced
this pull request
Dec 9, 2019
* initial commit for LL-API * fixing ml-agents-envs tests * Implementing action masks * training is fixed for 3DBall * Tests all fixed, gym is broken and missing documentation changes * adding case where no vector obs * Fixed Gym * fixing tests of float64 * fixing float64 * reverting some of brain.py * removing old proto apis * comment type fixes * added properties to AgentGroupSpec and edited the notebooks. * clearing the notebook outputs * Update gym-unity/gym_unity/tests/test_gym.py Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * Update gym-unity/gym_unity/tests/test_gym.py Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * Update ml-agents-envs/mlagents/envs/base_env.py Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * Update ml-agents-envs/mlagents/envs/base_env.py Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * addressing first comments * NaN checks for rewards are back * restoring Union[int, Tuple[int, ...]] for action_shape * Made BatchdStepResult an object * Made _agent_id_to_index private * Update ml-agents-envs/mlagents/envs/base_env.py Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * replacing np.array with np.ndarray in typing * adding a new type for AgentGroup and AgentId * fixing brain_info when vec_obs == 0 * Docs ll api (#3047) * LL-API documentation changes * fixes * deleting implementation details * Update docs/Python-API.md Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * edited the migrating docs * Update docs/Migrating.md Co-Authored-By: Chris Elion <chris.elion@unity3d.com> * adding a period * removing change log
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.
No description provided.