Navigation
API > API/Plugins > API/Plugins/VertexDeltaModel
The vertex delta model, which uses a GPU based neural network. This model acts more as an example of how to implement a model that only uses the GPU. It is not as efficient as the Neural Morph Model, even though that model runs on the CPU. Unlike the Neural Morph Model this Vertex Delta Model does not generate any morph targets. All the vertex deltas are directly output by the neural network. This buffer of output deltas remains on the GPU and is then used as input buffer directly inside an optimus deformer graph.
| Name | UVertexDeltaModel |
| Type | class |
| Header File | /Engine/Plugins/Animation/MLDeformer/VertexDeltaModel/Source/VertexDeltaModel/Public/VertexDeltaModel.h |
| Include Path | #include "VertexDeltaModel.h" |
Syntax
UCLASS ()
class UVertexDeltaModel : public UMLDeformerGeomCacheModel
Inheritance Hierarchy
- UMLDeformerModel → UMLDeformerGeomCacheModel → UVertexDeltaModel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVertexDeltaModel
(
const FObjectInitializer& ObjectInitializer |
VertexDeltaModel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BatchSize | int32 | The number of frames per batch when training the model. | VertexDeltaModel.h |
|
| LearningRate | float | The learning rate used during the model training. | VertexDeltaModel.h |
|
| NNEModel | TObjectPtr< UNNEModelData > | The NNE neural network model. | VertexDeltaModel.h | |
| NumHiddenLayers | int32 | The number of hidden layers that the neural network model will have.\nHigher numbers will slow down performance but can deal with more complex deformations. | VertexDeltaModel.h |
|
| NumIterations | int32 | The number of iterations to train the model for. | VertexDeltaModel.h |
|
| NumNeuronsPerLayer | int32 | The number of units/neurons per hidden layer. | VertexDeltaModel.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMLDeformerModelInstance * CreateModelInstance
(
UMLDeformerComponent* Component |
VertexDeltaModel.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
VertexDeltaModel.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
VertexDeltaModel.h | ||
int32 GetBatchSize() |
VertexDeltaModel.h | ||
virtual FString GetDefaultDeformerGraphAssetPath() |
VertexDeltaModel.h | ||
virtual FString GetDisplayName() |
VertexDeltaModel.h | ||
float GetLearningRate() |
VertexDeltaModel.h | ||
const FString GetNNERuntimeName() |
VertexDeltaModel.h | ||
int32 GetNumHiddenLayers() |
VertexDeltaModel.h | ||
int32 GetNumIterations() |
VertexDeltaModel.h | ||
int32 GetNumNeuronsPerLayer() |
VertexDeltaModel.h | ||
virtual bool IsNeuralNetworkOnGPU() |
VertexDeltaModel.h | ||
virtual bool IsTrained() |
VertexDeltaModel.h | ||
void SetNNEModelData
(
TObjectPtr< UNNEModelData > ModelData |
VertexDeltaModel.h |