UAnimGenControllerTrainingSettings

Class containing all the [UAnimGenController](API\Plugins\AnimGen\UAnimGenController) Editor window training settings

API > API/Plugins > API/Plugins/AnimGen

Class containing all the UAnimGenController Editor window training settings

   
Name UAnimGenControllerTrainingSettings
Type class
Header File /Engine/Plugins/Experimental/Animation/AnimGen/Source/AnimGen/Public/AnimGenController.h
Include Path #include "AnimGenController.h"

Syntax

UCLASS ()  
class UAnimGenControllerTrainingSettings : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActivationFunction EAnimGenActivationFunction The activation function used by the networks AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay
AutoEncoder TSoftObjectPtr< UAnimGenAutoEncoder > Input autoencoder to train the network with AnimGenController.h
  • EditAnywhere
  • Category="Data"
BatchSize int32 Batch size to use for training. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="1", UIMin="1", UIMax="16384")
Behavior TObjectPtr< UAnimGenBehavior > Input Behavior to train the network on AnimGenController.h
  • EditAnywhere
  • Instanced
  • Category="Data"
bEnableLogging bool If to enable logging to the UE log in the training subprocess. AnimGenController.h
  • EditAnywhere
  • Category="Training"
bEnableTensorboard bool If to enable logging to TensorBoard in the intermediate directory. AnimGenController.h
  • EditAnywhere
  • Category="Training"
bForceRefresh bool Flag to force refresh the query during update AnimGenController.h  
bUseCompressedLinearLayers bool If the controller should use compressed learning layers. AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay
ControlNoiseScale float Scale of noise to apply to the control inputs. Larger values may improve generalization a little. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
ControlObject FAnimGenControlObject Current Control Object AnimGenController.h  
ControlSchema FAnimGenControlSchema Current Control Schema AnimGenController.h  
ControlSchemaElement FAnimGenControlSchemaElement Current Control Schema Element AnimGenController.h  
ControlSets TArray< FAnimGenControlSet > Current Control Sets AnimGenController.h  
Database TSoftObjectPtr< UAnimDatabase > Input database to train the network with AnimGenController.h
  • EditAnywhere
  • Category="Data"
DatabaseContentHash int32 This hash is used to detect when the database might have changed and re-generate the control sets AnimGenController.h  
DebugDrawer TObjectPtr< UAnimDatabaseDebugDraw > Custom debug draw object that can be used to add additional debug draw behavior AnimGenController.h
  • EditAnywhere
  • Instanced
  • Category="Debug Draw"
DenoiserHiddenUnitNum int32 The number of hidden units used by the denoiser network on each layer AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • Meta=(ClampMin="1", UIMin="1")
DenoiserLayerNum int32 The number of layers used by the denoiser network AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • Meta=(ClampMin="2", UIMin="2")
DenoiserSteps int32 Number of denoising steps to use during training of distilled LODs. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="1", UIMin="1")
Device EAnimGenTrainingDevice The device to train on. Training on CPU, while possible, will typically be extremely slow. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
FrameRanges TObjectPtr< UAnimDatabaseFrameRangesFunction > Frame ranges in the database to use for training. Leave this as None to train on the full database AnimGenController.h
  • EditAnywhere
  • Instanced
  • Category="Data"
LearningRate float Learning rate. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
LOD0HiddenUnitNum int32 The number of hidden units used by the LOD0 network on each layer AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD0 Hidden Unit Num"
  • Meta=(ClampMin="1", UIMin="1")
LOD0LayerNum int32 The number of layers used by the LOD0 network AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD0 Layer Num"
  • Meta=(ClampMin="2", UIMin="2")
LOD1HiddenUnitNum int32 The number of hidden units used by the LOD1 network on each layer AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD1 Hidden Unit Num"
  • Meta=(ClampMin="1", UIMin="1")
LOD1LayerNum int32 The number of layers used by the LOD1 network AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD1 Layer Num"
  • Meta=(ClampMin="2", UIMin="2")
LOD2HiddenUnitNum int32 The number of hidden units used by the LOD2 network on each layer AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD2 Hidden Unit Num"
  • Meta=(ClampMin="1", UIMin="1")
LOD2LayerNum int32 The number of layers used by the LOD2 network AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • DisplayName="LOD2 Layer Num"
  • Meta=(ClampMin="2", UIMin="2")
NumberOfDistillationIterations int32 The number of iterations to train the distilled LOD networks. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="1", UIMin="1")
NumberOfTrainingIterations int32 The number of iterations to train the reference flow-matching network. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="1", UIMin="1")
PoseNoiseScale float The scale of noise to apply to the pose encoding during training. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
QueryEntries TArray< TSharedPtr< UE::AnimDatabase::Editor::FQueryEntry > > List of UI entries for the current query AnimGenController.h  
QueryRanges FAnimDatabaseFrameRanges Query Ranges object for the current query AnimGenController.h  
RandomPoseSampleRate float Rate at which to sample random previous poses during training. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
RandomSeed int32 The seed used for any random sampling the trainer will perform, e.g. for weight initialization. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="0", UIMin="0")
RangeIndentifierColorSeed int32 Seed used for the colors of the range identifiers AnimGenController.h  
SelectedRanges TArray< int32 > Indices of all the currently selected ranges AnimGenController.h  
WarmupIterations int32 The number of learning rate warm-up iterations to apply. Stabilizes the beginning of training. AnimGenController.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="1", UIMin="1")
WeightInit EAnimGenWeightInit Network weight initialization method AnimGenController.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForceRefresh()

 Forces the Update function to refresh the internal state AnimGenController.h
  • CallInEditor
  • Category="Data"
  • DisplayName="Refresh"

void LoadAutoEncoderAsync()

 Load the current auto-encoder. AnimGenController.h  

void LoadDatabaseAsync()

 Load the current database. AnimGenController.h  

bool Update ()

 Checks if ControlSets needs updating, and if so updates it. AnimGenController.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& Event
)

 We use this async load changes to Database/AutoEncoder AnimGenController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page