Skip to content

IGymConnector

class IGymConnector

An interface for connectors between unreal and gym.

Dependencies: FTrainingStateUpdate

Subclassed by: UAbstractGymConnector

Public Interface

Public Functions:

CollectEnvironments

inline virtual void CollectEnvironments()

Collect the environments that should be trained.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 31, column 14)

CollectEnvironmentStates

inline virtual void CollectEnvironmentStates()

Collect the states of the environments that are currently being trained.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 36, column 14)

SubmitEnvironmentStates

inline virtual void SubmitEnvironmentStates()

Submit the states of the environments to gym.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 41, column 14)

ResolveEnvironmentStateUpdate

inline virtual FTrainingStateUpdate * ResolveEnvironmentStateUpdate()

Resolve the state update from gym into a TrainingStateUpdate.

Returns: A ptr to the state update from gym

Returns: FTrainingStateUpdate *

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 47, column 30)

ResetCompletedEnvironments

inline virtual void ResetCompletedEnvironments()

Reset the environments that have completed their episodes.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 52, column 14)

UpdateEnvironments

inline virtual void UpdateEnvironments(FTrainingStateUpdate &StateUpdate)

Update the environments with the actions from the agents.

Parameters:

  • StateUpdate (FTrainingStateUpdate &) – [in] The state update from gym

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 58, column 14)

Enable

inline virtual void Enable()

Enable the connector.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 63, column 14)

CheckForStart

inline virtual bool CheckForStart()

Check if this connector is ready to start training.

Returns: True if the connector is ready to start training

Returns: bool

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 69, column 14)

Used By: UAbstractGymConnector

Source: Schola/Source/Schola/Public/GymConnectors/IGymConnector.h (line 23, column 1)