Class URPCImitationConnector

Defined in File gRPCImitationConnector.h

Inheritance Relationships

Base Type

public UAbstractImitationConnector (Class UAbstractImitationConnector)

class URPCImitationConnector : public UAbstractImitationConnector

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Dependencies: FImitationTrainingState, FInitialState, FLaunchableScript, FRPCServerSettings, FScriptSettings, FTrainingDefinition, IConsumerBackend, IProducerBackend, UCommunicationManager

A connection to an external imitation learning expert policy implemented via gRPC.

This connector communicates with external expert policies (e.g., in Python) to receive observations, actions, and rewards for imitation learning.

Public Functions

Symbol	Details
`URPCImitationConnector`	End of Settings.
`Init`	Initialize the gRPC connector with training definitions.
`CheckForStart`	Check if the connector received a start request and is ready to begin.
`SubmitStateWithInitialState`	Submit imitation state to external source with initial state information.
`SubmitState`	Submit imitation state to external source without initial state information.

URPCImitationConnector

URPCImitationConnector()

End of Settings.

Create a new URPCImitationConnector.

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Implementation: Source/Schola/Protobuf/Private/ImitationConnectors/gRPC/gRPCImitationConnector.cpp

Init

virtual void Init(const FTrainingDefinition &TrainingDefns) override

Initialize the gRPC connector with training definitions.

Parameters

TrainingDefns – [in] The training definitions for all agents

#	Direction	Name	Type	Description
1	—	`TrainingDefns`	`const FTrainingDefinition &`	The training definitions for all agents

Attributes: virtual

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Implementation: Source/Schola/Protobuf/Private/ImitationConnectors/gRPC/gRPCImitationConnector.cpp

CheckForStart

virtual bool CheckForStart() override

Check if the connector received a start request and is ready to begin.

Returns:

True if the connector is ready to start.

Attributes: virtual

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Implementation: Source/Schola/Protobuf/Private/ImitationConnectors/gRPC/gRPCImitationConnector.cpp

SubmitStateWithInitialState

virtual void SubmitStateWithInitialState(const FImitationTrainingState &InState,
                                         const FInitialState &InInitialState)

Submit imitation state to external source with initial state information.

Parameters

InState – [in] The imitation training state containing observations, actions, and rewards
InInitialState – [in] The initial state after any resets

#	Direction	Name	Type	Description
1	—	`InState`	`const FImitationTrainingState &`	The imitation training state containing observations, actions, and rewards
2	—	`InInitialState`	`const FInitialState &`	The initial state after any resets

Attributes: virtual

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Implementation: Source/Schola/Protobuf/Private/ImitationConnectors/gRPC/gRPCImitationConnector.cpp

SubmitState

virtual void SubmitState(const FImitationTrainingState &InState)

Submit imitation state to external source without initial state information.

Parameters

InState – [in] The imitation training state containing observations, actions, and rewards

#	Direction	Name	Type	Description
1	—	`InState`	`const FImitationTrainingState &`	The imitation training state containing observations, actions, and rewards

Attributes: virtual

Source: Source/Schola/Protobuf/Public/ImitationConnectors/gRPC/gRPCImitationConnector.h

Implementation: Source/Schola/Protobuf/Private/ImitationConnectors/gRPC/gRPCImitationConnector.cpp

Public Members

Symbol	Details
`bRunScriptOnPlay`	Settings.
`ServerSettings`	—
`ScriptSettings`	The settings for the python script to be launched.
`Script`	—

`bRunScriptOnPlay`

bool bRunScriptOnPlay = false

Settings.

`ServerSettings`

FRPCServerSettings ServerSettings

`ScriptSettings`

FScriptSettings ScriptSettings

The settings for the python script to be launched.

`Script`

FLaunchableScript Script