ULearningAgentsFlowMatchingTrainer

The [ULearningAgentsFlowMatchingTrainer](API\Plugins\LearningAgentsTraining\ULearningAgentsFlowMatchingTrain-) enables imitation learning with flow matching.

API > API/Plugins > API/Plugins/LearningAgentsTraining

The ULearningAgentsFlowMatchingTrainer enables imitation learning with flow matching. Inference actions are generated by integrating the learned velocity field with ODE approximates.

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

Syntax

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

Inheritance Hierarchy

Constructors

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

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULearningAgentsFlowMatchingTrainer()

   LearningAgentsFlowMatchingTrainer.h  

Variables

Protected

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginTraining ( const ULearningAgentsRecording* Recording,
const FLearningAgentsFlowMatchingTrainerSettings& FlowMatchingTrainerSettings,
const FLearningAgentsFlowMatchingTrainerTrainingSettings& FlowMatchingTrainerTrainingSettings,
const FLearningAgentsTrainerProcessSettings& FlowMatchingTrainerPathSettings
)

 Begins the training process with the provided settings. LearningAgentsFlowMatchingTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="FlowMatchingTrainerSettings,FlowMatchingTrainerTrainingSettings,FlowMatchingTrainerPathSettings")

void EndTraining()

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

void ExportToFile ( UE::Learning::FFileTrainer& FileTrainer,
const ULearningAgentsRecording* Recording,
const FLearningAgentsFlowMatchingTrainerSettings& FlowMatchingTrainerSettings,
const FLearningAgentsFlowMatchingTrainerTrainingSettings& FlowMatchingTrainerTrainingSettings,
UE::Learning::ETrainerExportFlags ExportFlags
)

 Exports training materials to file, only performing work needed for the requested export flags. LearningAgentsFlowMatchingTrainer.h  
Returns true if the trainer has failed to communicate with the external training process. LearningAgentsFlowMatchingTrainer.h
  • BlueprintPure
  • Category="LearningAgents"

bool IsTraining()

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

void IterateTraining()

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

void RunTraining ( const ULearningAgentsRecording* Recording,
const FLearningAgentsFlowMatchingTrainerSettings& FlowMatchingTrainerSettings,
const FLearningAgentsFlowMatchingTrainerTrainingSettings& FlowMatchingTrainerTrainingSettings,
const FLearningAgentsTrainerProcessSettings& FlowMatchingTrainerPathSettings
)

 Convenience function that runs a basic training loop. LearningAgentsFlowMatchingTrainer.h
  • BlueprintCallable
  • Category="LearningAgents"
  • Meta=(AutoCreateRefTerm="FlowMatchingTrainerSettings,FlowMatchingTrainerTrainingSettings,FlowMatchingTrainerPathSettings")

void SetupFlowMatchingTrainer ( ULearningAgentsManager* InManager,
ULearningAgentsInteractor* InInteractor,
ULearningAgentsFlowMatching* InFlowMatchingModel,
const FLearningAgentsCommunicator& Communicator
)

 Initializes the flow matching trainer and runs the setup functions. LearningAgentsFlowMatchingTrainer.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

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

Static

Name Remarks Include Path Unreal Specifiers

static ULearningAgentsFlowMatchingTrainer * MakeFlowMatchingTrainer ( ULearningAgentsManager*& InManager,
ULearningAgentsInteractor*& InInteractor,
ULearningAgentsFlowMatching*& InFlowMatchingModel,
const FLearningAgentsCommunicator& Communicator,
TSubclassOf< ULearningAgentsFlowMatchingTrainer > Class,
const FName Name
)

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

See Also

  • ULearningAgentsFlowMatching for the Denoiser class that performs ODE integration during inference.

  • 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