1. Epic GamesDeveloper
  3. ULearningAgentsPPOTrainer

ULearningAgentsPPOTrainer

API > API/Plugins > API/Plugins/LearningAgentsTraining

   
Name ULearningAgentsPPOTrainer
Type class
Header File /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgentsTraining/Public/LearningAgentsPPOTrainer.h
Include Path #include "LearningAgentsPPOTrainer.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
-- Setup -- LearningAgentsPPOTrainer.h  
  LearningAgentsPPOTrainer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULearningAgentsPPOTrainer()

   LearningAgentsPPOTrainer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionId int32   LearningAgentsPPOTrainer.h  
ActionModifierId int32   LearningAgentsPPOTrainer.h  
bHasTrainingFailed bool True if trainer encountered an unrecoverable error during training (e.g. the trainer process timed out). LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
bIsTraining bool True if training is currently in-progress. Otherwise, false. LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
Critic TObjectPtr< ULearningAgentsCritic > The current critic. LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
CriticNetworkId int32   LearningAgentsPPOTrainer.h  
DecoderNetworkId int32   LearningAgentsPPOTrainer.h  
EncoderNetworkId int32   LearningAgentsPPOTrainer.h  
EpisodeBuffer TUniquePtr< UE::Learning::FEpisodeBuffer >   LearningAgentsPPOTrainer.h  
Interactor TObjectPtr< ULearningAgentsInteractor > --Private Data -- LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
MemoryStateId int32   LearningAgentsPPOTrainer.h  
ObservationId int32   LearningAgentsPPOTrainer.h  
Policy TObjectPtr< ULearningAgentsPolicy > The current policy for experience gathering. LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
PolicyNetworkId int32   LearningAgentsPPOTrainer.h  
PreviousGameSettingsState UE::Learning::Agents::FGameSettingsState   LearningAgentsPPOTrainer.h  
ReplayBuffer TUniquePtr< UE::Learning::FReplayBuffer >   LearningAgentsPPOTrainer.h  
ReplayBufferId int32   LearningAgentsPPOTrainer.h  
RewardId int32   LearningAgentsPPOTrainer.h  
Trainer TSharedPtr< UE::Learning::IExternalTrainer >   LearningAgentsPPOTrainer.h  
TrainingEnvironment TObjectPtr< ULearningAgentsTrainingEnvironment > The training environment associated with this component. LearningAgentsPPOTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

 Will automatically call EndTraining if training is still in-progress when the object is destroyed. LearningAgentsPPOTrainer.h  

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

 Begins the training process with the provided settings. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="TrainerTrainingSettings,TrainingGameSettings")

void EndTraining()

 Stops the training process. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"

int32 GetEpisodeStepNum ( const int32 AgentId
) const

 Gets the number of step recorded in an episode for the given agent. LearningAgentsPPOTrainer.h
  • BlueprintPure
  • Category="LearningAgents"
  • Meta=(AgentId="-1")
Returns true if the trainer has failed to communicate with the external training process. LearningAgentsPPOTrainer.h
  • BlueprintPure
  • Category="LearningAgents"

const bool IsTraining ()

 -- Training Process -- LearningAgentsPPOTrainer.h
  • BlueprintPure
  • Category="LearningAgents"

virtual void OnAgentsAdded_Implementation ( const TArray< int32 >& AgentIds
)

   LearningAgentsPPOTrainer.h  

virtual void OnAgentsRemoved_Implementation ( const TArray< int32 >& AgentIds
)

   LearningAgentsPPOTrainer.h  

virtual void OnAgentsReset_Implementation ( const TArray< int32 >& AgentIds
)

   LearningAgentsPPOTrainer.h  

void ProcessExperience ( const bool bResetAgentsOnUpdate
)

 Call this function at the end of each step of your training loop. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"

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

 Convenience function that runs a basic training loop. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="TrainerTrainingSettings,TrainingGameSettings")

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

 Initializes the trainer. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="TrainerSettings")

Static

Name Remarks Include Path Unreal Specifiers

static 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. LearningAgentsPPOTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(Class="/Script/LearningAgents.LearningAgentsPPOTrainer", DeterminesOutputType="Class", AutoCreateRefTerm="TrainerSettings")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page