UAnimGenAutoEncoderTrainingSettings

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

API > API/Plugins > API/Plugins/AnimGen

Class containing all the UAnimGenAutoEncoder Editor window training settings

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

Syntax

UCLASS ()  
class UAnimGenAutoEncoderTrainingSettings :  
    public UObject ,  
    public IBoneReferenceSkeletonProvider

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActivationFunction EAnimGenActivationFunction The activation function used by the auto-encoder AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay
AttributeWeightMultiplier float Increase this if the attributes are not being accurately reproduced AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", UIMin="0.0")
AutoEncoderDebugDrawer TObjectPtr< UAnimGenAutoEncoderDebugDraw > Custom debug draw object that can be used to add additional debug draw behavior AnimGenAutoEncoder.h
  • EditAnywhere
  • Instanced
  • Category="Debug Draw"
BaseWeightMultiplier float Increase this if the network is not accurately reproducing bones at the end of joint chains AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", UIMin="0.0")
BatchSize int32 Batch size to use for training. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="1", UIMin="1", UIMax="4096")
bEnableLogging bool If to enable logging to the UE log in the training subprocess. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
bEnableTensorboard bool If to enable logging to TensorBoard in the intermediate directory. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
bExcludeVirtualBones bool If to exclude virtual bones AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
  • AdvancedDisplay
bForceRefresh bool Flag to force refresh the query during update AnimGenAutoEncoder.h  
bUseCompressedLinearLayers bool If the auto-encoder should use compressed learning layers. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay
Database TSoftObjectPtr< UAnimDatabase > Input database to train the network with AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
DatabaseContentHash int32 This hash is used to detect when the database might have changed and re-run the query AnimGenAutoEncoder.h  
DatabaseDebugDrawer TObjectPtr< UAnimDatabaseDebugDraw > Custom database debug draw object that can be used to add additional debug draw behavior AnimGenAutoEncoder.h
  • EditAnywhere
  • Instanced
  • Category="Debug Draw"
Device EAnimGenTrainingDevice The device to train on. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
EncodingSize int32 The encoding size used by the auto-encoder to compress the pose AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • Meta=(ClampMin="1", UIMin="1")
ExcludedBones TArray< FBoneReference > List of bones to exclude from training AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
FrameAttributes TArray< FAnimDatabaseFrameAttributeEntry > List of Frame Attributes to train the network to reproduce AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
FrameRanges TObjectPtr< UAnimDatabaseFrameRangesFunction > Frame ranges in the database to use for training. Leave this as None to train on the full database AnimGenAutoEncoder.h
  • EditAnywhere
  • Instanced
  • Category="Data"
HiddenUnitNum int32 The number of hidden units used by the auto-encoder on each layer AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • Meta=(ClampMin="1", UIMin="1")
LayerNum int32 The number of layers used by the encoder and decoder networks AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • Meta=(ClampMin="1", UIMin="1")
LearningRate float Learning rate. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
NumberOfIterations int32 The number of iterations to train the auto-encoder for. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • Meta=(ClampMin="1", UIMin="1")
QueryEntries TArray< TSharedPtr< UE::AnimDatabase::Editor::FQueryEntry > > List of UI entries for the current query AnimGenAutoEncoder.h  
QueryRanges FAnimDatabaseFrameRanges Query Ranges object for the current query AnimGenAutoEncoder.h  
RandomSeed int32 The seed used for any random sampling the trainer will perform, e.g. for weight initialization. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="0", UIMin="0")
RangeIndentifierColorSeed int32 Seed used for the colors of the range identifiers AnimGenAutoEncoder.h  
RootWeightMultiplier float Increase this if the root motion is not being accurately reproduced AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Data"
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", UIMin="0.0")
SelectedRanges TArray< int32 > Indices of all the currently selected ranges AnimGenAutoEncoder.h  
WarmupIterations int32 The number of learning rate warm-up iterations to apply. Stabilizes the beginning of training. AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Training"
  • AdvancedDisplay
  • Meta=(ClampMin="1", UIMin="1")
WeightInit EAnimGenWeightInit Network weight initialization method AnimGenAutoEncoder.h
  • EditAnywhere
  • Category="Network"
  • AdvancedDisplay

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForceRefresh()

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

USkeleton * GetSkeleton ( bool& bInvalidSkeletonIsError,
const IPropertyHandle* PropertyHandle
)

   AnimGenAutoEncoder.h  

void LoadDatabaseAsync()

 Load the current database. AnimGenAutoEncoder.h  

bool Update ()

 Checks if QueryRanges needs updating, and if so updates it. AnimGenAutoEncoder.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 AnimGenAutoEncoder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page