1. Epic GamesDeveloper
  3. ULearningAgentsRecorder

ULearningAgentsRecorder

A component that can be used to create recordings of training data for imitation learning.

API > API/Plugins > API/Plugins/LearningAgentsTraining

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Blueprintable&41;  
class ULearningAgentsRecorder : public ULearningAgentsManagerComponent

Remarks

A component that can be used to create recordings of training data for imitation learning.

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 void While recording, adds the current observations and actions of the added agents to the internal buffer.
Public function UFunction BlueprintCallable, Category, Meta void Append to the current recording object from a file.
Public function UFunction BlueprintCallable, Category, Meta void Appends the current recording object to the given recording asset
Public function UFunction BlueprintCallable, Category void

BeginRecording ( bool bReinitializeRecording
)

 Recording Process
Public function UFunction BlueprintCallable, Category void Ends the recording of the observations and actions of each agent and stores them in the current recording object.
Public function Const UFunction BlueprintPure, Category const ULearningAgentsRecording * Gets the current recording object. Note: this may be empty until EndRecording has been called.
Public function Const UFunction BlueprintPure, Category bool Returns true if recording is active; Otherwise, false.
Public function UFunction BlueprintCallable, Category void Loads the current recording object from the given recording asset
Public function UFunction BlueprintCallable, Category, Meta void Load / Save
Public function UFunction BlueprintCallable, Category, Meta void Saves the current recording object to the given recording asset
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SaveRecordingToFile ( const FFilePath& File
)

 Saves the current recording object to a file
Public function UFunction BlueprintCallable, Category void

SetupRecorder ( ULearningAgentsInteractor* InInteractor,
const FLearningAgentsRecorderPathSettings& RecorderPathSettings,
ULearningAgentsRecording* RecordingAsset
)

 Initializes this object and runs the setup functions for the underlying data storage.
Public function UFunction BlueprintCallable, Category void Uses the given recording asset. New recordings will be appended to this.

Overridden from ULearningAgentsManagerComponent

  Type Name Description
Public function Virtual void

OnAgentsRemoved ( const TArray< int32 >& AgentIds
)

 Called whenever agents are removed from the parent ALearningAgentsManager object.
Public function Virtual void

OnAgentsReset ( const TArray< int32 >& AgentIds
)

 Called whenever agents are reset on the parent ALearningAgentsManager object.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Will automatically call EndRecording if recording is still in-progress when play is ending.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page