Namespace Unity.MLAgents.SideChannels

Classes

FloatPropertiesChannel

Side channel that is comprised of a collection of float variables.

IncomingMessage

Utility class for reading the data sent to the SideChannel.

OutgoingMessage

Utility class for forming the data that is sent to the SideChannel.

RawBytesChannel

Side channel for managing raw bytes of data. It is up to the clients of this side channel to interpret the messages.

Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is outside of the traditional machine learning loop. ML-Agents provides some specific implementations of side channels, but users can create their own.

To create your own, you'll need to create two, new mirrored classes, one in Unity (by extending SideChannel) and another in Python by extending a Python class also called SideChannel. Then, within your project, use RegisterSideChannel(SideChannel) and UnregisterSideChannel(SideChannel) to register and unregister your custom side channel.

SideChannelManager

Collection of static utilities for managing the registering/unregistering of Unity.MLAgents.SideChannels and the sending/receiving of messages for all the channels.