1. Epic GamesDeveloper
  3. ULearningAgentsPPOTrainer

ULearningAgentsPPOTrainer

API > API/Plugins > API/Plugins/LearningAgentsTraining

Inheritance Hierarchy

References

   
Module LearningAgentsTraining
Header /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgentsTraining/Public/LearningAgentsPPOTrainer.h
Include #include "LearningAgentsPPOTrainer.h"

Syntax

UCLASS (BlueprintType, Blueprintable, Meta=(BlueprintSpawnableComponent))  
class ULearningAgentsPPOTrainer : public ULearningAgentsManagerListener

Constructors

  Type Name Description
Public function   -- Setup --
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void

BeginTraining ( const FLearningAgentsPPOTrainingSettings& TrainerTrainingSettings,
const FLearningAgentsTrainingGameSettings& TrainingGameSettings,
const bool bResetAgentsOnBegin
)

 Begins the training process with the provided settings.
Public function UFunction BlueprintCallable, Category void Stops the training process.
Public function Const UFunction BlueprintPure, Category, Meta int32

GetEpisodeStepNum ( const int32 AgentId
)

 Gets the number of step recorded in an episode for the given agent.
Public function Const UFunction BlueprintPure, Category bool Returns true if the trainer has failed to communicate with the external training process.
Public function Const UFunction BlueprintPure, Category const bool -- Training Process --
Public function Static UFunction BlueprintCallable, Category, Meta ULearningAgentsPPOTrainer *

MakePPOTrainer ( ULearningAgentsManager*& InManager,
ULearningAgentsInteractor*& InInteractor,
ULearningAgentsTrainingEnvironment*& InTrainingEnvironment,
ULearningAgentsPolicy*& InPolicy,
ULearningAgentsCritic*& InCritic,
const FLearningAgentsCommunicator& Communicator,
TSubclassOf< ULearningAgentsPPOTrainer > Class,
const FName Name,
const FLearningAgentsPPOTrainerSettings& TrainerSettings
)

 Constructs the trainer.
Public function Virtual void

OnAgentsAdded_Implementation ( const TArray< int32 >& AgentIds
)

  
Public function Virtual void  
Public function Virtual void

OnAgentsReset_Implementation ( const TArray< int32 >& AgentIds
)

  
Public function UFunction BlueprintCallable, Category void

ProcessExperience ( const bool bResetAgentsOnUpdate
)

 Call this function at the end of each step of your training loop.
Public function UFunction BlueprintCallable, Category, Meta void

RunTraining ( const FLearningAgentsPPOTrainingSettings& TrainerTrainingSettings,
const FLearningAgentsTrainingGameSettings& TrainingGameSettings,
const bool bResetAgentsOnBegin,
const bool bResetAgentsOnUpdate
)

 Convenience function that runs a basic training loop.
Public function UFunction BlueprintCallable, Category, Meta void

SetupPPOTrainer ( ULearningAgentsManager*& InManager,
ULearningAgentsInteractor*& InInteractor,
ULearningAgentsTrainingEnvironment*& InTrainingEnvironment,
ULearningAgentsPolicy*& InPolicy,
ULearningAgentsCritic*& InCritic,
const FLearningAgentsCommunicator& Communicator,
const FLearningAgentsPPOTrainerSettings& TrainerSettings
)

 Initializes the trainer.

Overridden from UObject

  Type Name Description
Public function Virtual void Will automatically call EndTraining if training is still in-progress when the object is destroyed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page