Split and improve side channel / LL-API documentation #3574
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
vincentpierre
approved these changes
Mar 5, 2020
docs/Custom-SideChannels.md
Outdated
| @@ -0,0 +1,190 @@ | |||
| # Custom Side Channels | |||
|
|
|||
| You can create your own side channel in C# and Python and use it to communicate custom data structures between the two. This can be useful for situations in which the information to be sent is too complex or structured for the built-in `FloatPropertiesChannel`, or too one-off to be appropriate as an agent observation. | |||
There was a problem hiding this comment.
I don't think you can say information is "too structured" or "too one-off".
docs/Custom-SideChannels.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Once we have defined our custom side channel class, we need to ensure that it is instantiated and registered. This can typically be done wherever the logic of the side channel makes sense to be associated, for example on a monobehavior object that might need to access data from the side channel. Here we show a simple MonoBehavior object which instantiates and registeres the new side channel. If you have not done it already, make sure that the monobehavior which registers the side channel is connected to a gameobject which will be live in your Unity scene. |
There was a problem hiding this comment.
I think you should split the lines that are too long.
monobehavior --> MonoBehaviour
There was a problem hiding this comment.
connected --> attached
docs/Custom-SideChannels.md
Outdated
| // When a Debug.Log message is created, we send it to the stringChannel | ||
| Application.logMessageReceived += stringChannel.SendDebugStatementToPython; | ||
|
|
||
| // Just in case the Academy has not yet initialized |
There was a problem hiding this comment.
Not sure what this comment means, this is the only way to register the side channel on C#
There was a problem hiding this comment.
Haha. You wrote it :) Happy to remove/change.
docs/Python-API.md
Outdated
| Now, if you run this script and press `Play` the Unity Editor when prompted, The console in the Unity Editor will | ||
| display a message at every Python step. Additionally, if you press the Space Bar in the Unity Engine, a message will | ||
| appear in the terminal. | ||
| For information on how to make custom side channels for sending additional data types, see the documentation [here](Custom-SideChannels.md). |
There was a problem hiding this comment.
dead link. I think ../Custom-SideChannels.md
There was a problem hiding this comment.
That is weird. They all seem to work for me.
There was a problem hiding this comment.
All right my bad, if the markdown check says yes then yes
Co-Authored-By: Vincent-Pierre BERGES <vincentpierre@unity3d.com>
…echnologies/ml-agents into develop-sidechannel-docs
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)
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
Types of change(s)
Checklist
Other comments