Class CommunicatorFactory

Factory class for an ICommunicator instance. This is used to the Academy at startup. By default, on desktop platforms, an ICommunicator will be created and attempt to connect to a trainer. This behavior can be prevented by setting Enabled to false before the Academy is initialized.

Inheritance
object
CommunicatorFactory
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Unity.MLAgents
Assembly: Unity.ML-Agents.dll
Syntax
public static class CommunicatorFactory

Properties

CommunicatorRegistered

Check if a communicator has been registered.

Declaration
public static bool CommunicatorRegistered { get; }
Property Value
Type Description
bool

Enabled

Whether or not an ICommunicator instance will be created when the Academy is initialized. Changing this has no effect after the Academy has already been initialized.

Declaration
public static bool Enabled { get; set; }
Property Value
Type Description
bool

Methods

ClearCreator()

Clear the registered creator.

Declaration
public static void ClearCreator()

Register<T>(Func<T>)

Register a function that will create an ICommunicator instance.

Declaration
public static void Register<T>(Func<T> creator) where T : ICommunicator
Parameters
Type Name Description
Func<T> creator

Creator
Type Parameters
Name Description
T

Type of communicator

Did you find this page useful? Please give it a rating: