1. Epic GamesDeveloper
  3. ULearningAgentsImitationTrainer

ULearningAgentsImitationTrainer

The [ULearningAgentsImitationTrainer](API\Plugins\LearningAgentsTraining\ULearningAgentsImitationTrainer) enable imitation learning, i.e. learning from human/AI demonstrations.

API > API/Plugins > API/Plugins/LearningAgentsTraining

The ULearningAgentsImitationTrainer enable imitation learning, i.e. learning from human/AI demonstrations. Imitation training is typically much faster than reinforcement learning, but requires gathering large amounts of data in order to generalize. This can be used to initialize a reinforcement learning policy to speed up initial exploration.

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable)  
class ULearningAgentsImitationTrainer : public ULearningAgentsManagerListener

Inheritance Hierarchy

Constructors

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

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULearningAgentsImitationTrainer()

   LearningAgentsImitationTrainer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionId int32   LearningAgentsImitationTrainer.h  
bHasTrainingFailed bool True if trainer encountered an unrecoverable error during training (e.g. the trainer process timed out). LearningAgentsImitationTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
bIsTraining bool True if training is currently in-progress. Otherwise, false. LearningAgentsImitationTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
DecoderNetworkId int32   LearningAgentsImitationTrainer.h  
EncoderNetworkId int32   LearningAgentsImitationTrainer.h  
Interactor TObjectPtr< ULearningAgentsInteractor > --Private Data -- LearningAgentsImitationTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
MemoryStateId int32   LearningAgentsImitationTrainer.h  
ObservationId int32   LearningAgentsImitationTrainer.h  
Policy TObjectPtr< ULearningAgentsPolicy > The policy being trained. LearningAgentsImitationTrainer.h
  • VisibleAnywhere
  • Transient
  • Category="LearningAgents"
PolicyNetworkId int32   LearningAgentsImitationTrainer.h  
ReplayBuffer TUniquePtr< UE::Learning::FReplayBuffer >   LearningAgentsImitationTrainer.h  
ReplayBufferId int32   LearningAgentsImitationTrainer.h  
Trainer TSharedPtr< UE::Learning::IExternalTrainer >   LearningAgentsImitationTrainer.h  

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. LearningAgentsImitationTrainer.h  

void BeginTraining ( const ULearningAgentsRecording* Recording,
const FLearningAgentsImitationTrainerSettings& ImitationTrainerSettings,
const FLearningAgentsImitationTrainerTrainingSettings& ImitationTrainerTrainingSettings,
const FLearningAgentsTrainerProcessSettings& ImitationTrainerPathSettings
)

 Begins the training process with the provided settings. LearningAgentsImitationTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="ImitationTrainerSettings,ImitationTrainerTrainingSettings,ImitationTrainerPathSettings")

void EndTraining()

 Stops the training process. LearningAgentsImitationTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
Returns true if the trainer has failed to communicate with the external training process. LearningAgentsImitationTrainer.h
  • BlueprintPure
  • Category="LearningAgents"

bool IsTraining()

 Returns true if the trainer is currently training; Otherwise, false. LearningAgentsImitationTrainer.h
  • BlueprintPure
  • Category="LearningAgents"

void IterateTraining()

 Iterates the training process and gets the updated policy network. LearningAgentsImitationTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"

void RunTraining ( const ULearningAgentsRecording* Recording,
const FLearningAgentsImitationTrainerSettings& ImitationTrainerSettings,
const FLearningAgentsImitationTrainerTrainingSettings& ImitationTrainerTrainingSettings,
const FLearningAgentsTrainerProcessSettings& ImitationTrainerPathSettings
)

 Convenience function that runs a basic training loop. LearningAgentsImitationTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="ImitationTrainerSettings,ImitationTrainerTrainingSettings,ImitationTrainerPathSettings")

void SetupImitationTrainer ( ULearningAgentsManager* InManager,
ULearningAgentsInteractor* InInteractor,
ULearningAgentsPolicy* InPolicy,
const FLearningAgentsCommunicator& Communicator
)

 Initializes the imitation trainer and runs the setup functions. LearningAgentsImitationTrainer.h  

Static

Name Remarks Include Path Unreal Specifiers

static ULearningAgentsImitationTrainer * MakeImitationTrainer ( ULearningAgentsManager*& InManager,
ULearningAgentsInteractor*& InInteractor,
ULearningAgentsPolicy*& InPolicy,
const FLearningAgentsCommunicator& Communicator,
TSubclassOf< ULearningAgentsImitationTrainer > Class,
const FName Name
)

 Constructs the imitation trainer and runs the setup functions. LearningAgentsImitationTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(Class="/Script/LearningAgentsTraining.LearningAgentsImitationTrainer", DeterminesOutputType="Class")

See Also

  • ULearningAgentsInteractor to understand how observations and actions work.

  • ULearningAgentsController to understand how we can manually perform actions via a human or AI.

  • ULearningAgentsRecorder to understand how to make new recordings.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page