1. Epic GamesDeveloper
  3. Learning

Learning

API > API/Plugins

   
Name Learning
Type Plugin
Part of Plugins Learning Agents
Location /Engine/Plugins/Experimental/LearningAgents/Source/Learning/
Module Build Rules Learning.Build.cs

Classes

Name Remarks
FLearningModule  
TMultiArray Templated dynamic multi-dimensional array
TMultiArrayShape  
TMultiArrayView Templated fixed-size view of multi-dimensional array
ULearningNeuralNetworkData Neural Network Data Object

Structs

Name Remarks
FAdamOptimizer Adam Optimizer
FAdamOptimizerSettings  
FCMAOptimizer CMA OptimizerBlack box optimizer based on Covariance Matrix Adaption
FCMAOptimizerSettings Settings for the CMA Optimizer
FFrameAttribute A FFrameAttribute represents a attribute associated with every frame in a FFrameRangeSet.
FFrameRangeSet A FFrameRangeSet represents a set of ranges within a set of sequences.
FFrameSet A FrameSet represents a set of frames within a set of sequences.
FIndexSet FIndexSet represents a set of indices - more specifically, either a slice of indices, or an ArrayView of int32 which acts as the set of indices.
FIndexSetIterator Iterator for FIndexSet (see below)
FModifier Action Modifier
FModifierAndParameters  
FModifierArrayParameters  
FModifierContinuousParameters  
FModifierDiscreteExclusiveParameters  
FModifierDiscreteInclusiveParameters  
FModifierElement Action Modifier Element
FModifierEncodingParameters  
FModifierNamedDiscreteExclusiveParameters  
FModifierNamedDiscreteInclusiveParameters  
FModifierOrExclusiveParameters  
FModifierOrInclusiveParameters  
FNetworkSettings Settings for building a network from a schema.
FNetworkSettings Settings for building a network from a schema.
FNeuralNetwork Neural Network Object
FNeuralNetworkCritic Neural-network based critic object.
FNeuralNetworkFunction Neural-network based function object.
FNeuralNetworkInference Neural Network Inference Object
FNeuralNetworkInferenceSettings Settings object for a neural network instance
FNeuralNetworkPolicy Neural-network based policy object.
FObject Action Object
FObject Observation Object
FObjectAndParameters  
FObjectAndParameters  
FObjectArrayParameters  
FObjectArrayParameters  
FObjectContinuousParameters  
FObjectContinuousParameters  
FObjectConv1dParameters  
FObjectConv2dParameters  
FObjectDiscreteExclusiveParameters  
FObjectDiscreteExclusiveParameters  
FObjectDiscreteInclusiveParameters  
FObjectDiscreteInclusiveParameters  
FObjectElement Observation Object Element
FObjectElement Action Object Element
FObjectEncodingParameters  
FObjectEncodingParameters  
FObjectNamedDiscreteExclusiveParameters  
FObjectNamedDiscreteExclusiveParameters  
FObjectNamedDiscreteInclusiveParameters  
FObjectNamedDiscreteInclusiveParameters  
FObjectOrExclusiveParameters  
FObjectOrExclusiveParameters  
FObjectOrInclusiveParameters  
FObjectOrInclusiveParameters  
FObjectSetParameters  
FOptimizationPlannerBuffer Basic buffer containing some additional data used during optimization planning
FPCAEncoder Represents a PCA transformation which can be used to encode data
FPCAResult Details of the result of the PCA fitting.
FPCASettings PCA settings.
FProgress Simple thread-safe structure to record progress of some long-running computation.
FPSOOptimizer PSO OptimizerGradient free optimizer based on Particle Swarm Optimization
FPSOOptimizerSettings Settings for the PSO Optimizer.
FResetInstanceBuffer This object stores essentially a list of instances that need to be reset.
FSchema Observation Schema
FSchema Action Schema
FSchemaAndParameters  
FSchemaAndParameters  
FSchemaArrayParameters  
FSchemaArrayParameters  
FSchemaContinuousParameters  
FSchemaContinuousParameters  
FSchemaConv1dParameters  
FSchemaConv2dParameters  
FSchemaDiscreteExclusiveParameters  
FSchemaDiscreteExclusiveParameters  
FSchemaDiscreteInclusiveParameters  
FSchemaDiscreteInclusiveParameters  
FSchemaElement Action Schema Element
FSchemaElement Observation Schema Element
FSchemaEncodingParameters  
FSchemaEncodingParameters  
FSchemaNamedDiscreteExclusiveParameters  
FSchemaNamedDiscreteExclusiveParameters  
FSchemaNamedDiscreteInclusiveParameters  
FSchemaNamedDiscreteInclusiveParameters  
FSchemaOrExclusiveParameters  
FSchemaOrExclusiveParameters  
FSchemaOrInclusiveParameters  
FSchemaOrInclusiveParameters  
FSchemaSetParameters  
FScopeNullableReadLock Scoped read lock, which can optionally be null
FScopeNullableWriteLock Scoped write lock, which can optionally be null
IOptimizer Interface for an Optimizer
TIsCompatibleRangeType Copied from Core/Public/Containers/ArrayView.h
TIsReinterpretableRangeType Copied from Core/Public/Containers/ArrayView.h

Typedefs

Name Type Remarks Include Path
BinaryOpFunction TFunctionRef< void( FFrameAttribute &Out, const FFrameAttribute &Lhs, const FFrameAttribute &Rhs, const TLearningArrayView< 1, const int32 > OutRangeOffsets, const TLearningArrayView< 1, const int32 > LhsRangeOffsets, const TLearningArrayView< 1, const int32 > RhsRangeOffsets, const TLearningArrayView< 1, const int32 > RangeLengths)> Binary op function. LearningFrameAttribute.h
ConstFrameAttributePtr const FFrameAttribute * Convenience type to make the definition and usage of NaryOp easier LearningFrameAttribute.h
NaryOpFunction TFunctionRef< void( FFrameAttribute &Out, const TArrayView< const ConstFrameAttributePtr > In, const TLearningArrayView< 1, const int32 > OutRangeOffsets, const TArrayView< const TLearningArrayView< 1, const int32 > > InRangeOffsets, const TLearningArrayView< 1, const int32 > RangeLengths)> Nary op function. LearningFrameAttribute.h
NullaryOpFunction TFunctionRef< void( FFrameAttribute &Out, const TLearningArrayView< 1, const int32 > RangeOffsets, const TLearningArrayView< 1, const int32 > RangeLengths)> Nullary op function. LearningFrameAttribute.h
ReduceOpFunction TFunctionRef< void( const FFrameAttribute &In, const TLearningArrayView< 1, const int32 > RangeOffsets, const TLearningArrayView< 1, const int32 > RangeLengths)> Reduce op function. LearningFrameAttribute.h
TConstMultiArrayView TMultiArrayView< InDimNum, const InElementType >   MultiArrayView.h
TLearningArray TMultiArray< DimNum, ElementType, Allocator >   LearningArray.h
TLearningArrayShape TMultiArrayShape< DimNum >   LearningArray.h
TLearningArrayView TMultiArrayView< DimNum, ElementType >   LearningArray.h
TLearningConstArrayView TConstMultiArrayView< DimNum, ElementType >   LearningArray.h
UnaryOpFunction TFunctionRef< void( FFrameAttribute &Out, const FFrameAttribute &In, const TLearningArrayView< 1, const int32 > RangeOffsets, const TLearningArrayView< 1, const int32 > RangeLengths)> Unary op function. LearningFrameAttribute.h

Enums

Public

Name Remarks
UE::Learning::Action::EEncodingActivationFunction Activation Function to use for encoding
UE::Learning::Action::EType Action Type
UE::Learning::Action::EWeightInitialization Network weight initialization type
UE::Learning::ECompletionMode Completion Mode
UE::Learning::ELogSetting Log Settings
UE::Learning::Observation::EEncodingActivationFunction Activation Function to use for encoding
UE::Learning::Observation::EPaddingMode Enum of Padding Mode
UE::Learning::Observation::EType Observation Type
UE::Learning::Observation::EWeightInitialization Network weight initialization type

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TIsCompatibleElementType_V bool Copied from Core/Public/Containers/ArrayView.h MultiArrayView.h  
TMultiArrayElementsAreCompatible_V bool Copied from Core/Public/Containers/Array.h MultiArray.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void UE::Learning::Array::Check ( const TLearningArrayView< InDimNum, InElementType > View
)

 Check that an array view does not contain any NaN, Inf, -Inf LearningArray.h  

void UE::Learning::Array::Check ( const TLearningArray< InDimNum, InElementType, Allocator >& View
)

 Check that an array does not contain any NaN, Inf, -Inf LearningArray.h  

void UE::Learning::Array::Check ( const TLearningArrayView< InDimNum, InElementType > View,
const FIndexSet Indices
)

 Check that an array view does not contain any NaN, Inf, -Inf LearningArray.h  

void UE::Learning::Array::Check ( const TLearningArray< InDimNum, InElementType >& View,
const FIndexSet Indices
)

 Check that an array view does not contain any NaN, Inf, -Inf LearningArray.h  

void UE::Learning::Array::CheckShapesEqual ( const TLearningArrayShape< InDimNum >& Lhs,
const TLearningArrayShape< InDimNum >& Rhs
)

 Check that two array shapes are equal. LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
TLearningArrayView< InDimNum, InElementType > Src
)

 Copy the contents of one array view into another LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, Allocator >& Dst,
const TLearningArrayView< InDimNum, const InElementType > Src
)

 Copy the contents of one array view into another array LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArray< InDimNum, InElementType, Allocator >& Src
)

 Copy the contents of one array into another array view LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, AllocatorLhs >& Dst,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Src
)

 Copy the contents of one array into another array LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArrayView< InDimNum, const InElementType > Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArrayView< InDimNum, InElementType > Dst,
const TLearningArray< InDimNum, InElementType, Allocator >& Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, AllocatorLhs >& Dst,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another LearningArray.h  

void UE::Learning::Array::Copy ( TLearningArray< InDimNum, InElementType, Allocator >& Dst,
const TLearningArrayView< InDimNum, const InElementType > Src,
const FIndexSet Indices
)

 Copy the contents of one array view into another LearningArray.h  

void UE::Learning::Array::DeserializeFromBytes32 ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
TArray< InElementType, Allocator >& OutArray
)

 Deserialize an array from bytes LearningArray.h  

void UE::Learning::Array::DeserializeFromBytes32 ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
TLearningArray< InDimNum, InElementType, Allocator >& OutArray
)

 Deserialize an array from bytes LearningArray.h  

bool UE::Learning::Array::Equal ( const TLearningArray< InDimNum, InElementType, AllocatorLhs >& Lhs,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Rhs
)

 Check if the contents of one array equals the contents of another. LearningArray.h  

bool UE::Learning::Array::Equal ( const TLearningArrayView< InDimNum, const InElementType > Lhs,
const TLearningArray< InDimNum, InElementType, AllocatorRhs >& Rhs
)

 Check if the contents of one array equals the contents of another. LearningArray.h  

bool UE::Learning::Array::Equal ( const TLearningArray< InDimNum, InElementType, AllocatorLhs >& Lhs,
const TLearningArrayView< InDimNum, const InElementType >& Rhs
)

 Check if the contents of one array equals the contents of another. LearningArray.h  

bool UE::Learning::Array::Equal ( const TLearningArrayView< InDimNum, const InElementType > Lhs,
const TLearningArrayView< InDimNum, const InElementType > Rhs
)

 Check if the contents of one array equals the contents of another. LearningArray.h  

FString UE::Learning::Array::Format ( const TLearningArrayView< 1, const InElementType > Array,
const TFunctionRef< FString(const InElementType&)> Formatter,
const int32 MaxItemNum
)

   LearningArray.h  

int64 UE::Learning::Array::IndexOf ( const TLearningArrayView< 1, const InElementType > Array,
const InElementType& Element
)

   LearningArray.h  

int64 UE::Learning::Array::IndexOf ( const TLearningArray< 1, InElementType >& Array,
const InElementType& Element
)

   LearningArray.h  

int32 UE::Learning::Array::SerializationByteNum32 ( const TLearningArrayShape< InDimNum > Shape
)

 Serialization byte num LearningArray.h  

void UE::Learning::Array::Serialize ( FArchive& Ar,
TLearningArray< InDimNum, InElementType, Allocator >& Array
)

 Serialize an array LearningArray.h  

void UE::Learning::Array::SerializeToBytes32 ( int64& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const TLearningArray< InDimNum, InElementType, Allocator >& InArray
)

 Serialize an array to bytes LearningArray.h  

void UE::Learning::Array::SerializeToBytes32 ( int64& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const TMultiArrayShape< InDimNum > Shape,
const TArray< InElementType, Allocator >& InArray
)

 Serialize an array to bytes LearningArray.h  

void UE::Learning::Array::Set ( TLearningArrayView< InDimNum, InElementType > View,
const InElementType& Element
)

 Set each item of an array view to the given element LearningArray.h  

void UE::Learning::Array::Set ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const InElementType& Element
)

 Set each item of an array to the given element LearningArray.h  

void UE::Learning::Array::Set ( TLearningArrayView< InDimNum, InElementType > View,
const InElementType& Element,
const FIndexSet Indices
)

 Set each item of an array view to the given element LearningArray.h  

void UE::Learning::Array::Set ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const InElementType& Element,
const FIndexSet Indices
)

 Set each item of an array to the given element LearningArray.h  

void UE::Learning::Array::ShiftLeft ( TLearningArray< InDimNum, InElementType, Allocator >& Array,
const int64 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same. LearningArray.h  

void UE::Learning::Array::ShiftLeft ( TLearningArray< 1, InElementType, Allocator >& Array,
const int64 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same. LearningArray.h  

void UE::Learning::Array::ShiftLeft ( TLearningArrayView< InDimNum, InElementType > Array,
const int64 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same. LearningArray.h  

void UE::Learning::Array::ShiftLeft ( TLearningArrayView< 1, InElementType > Array,
const int64 ShiftNum
)

 Shift all elements in an array to the left. Data at the end of the array will remain the same. LearningArray.h  

void UE::Learning::Array::Zero ( TLearningArrayView< InDimNum, InElementType > View
)

 Zero the memory of an array view LearningArray.h  

void UE::Learning::Array::Zero ( TLearningArray< InDimNum, InElementType, Allocator >& Array
)

 Zero the memory of an array LearningArray.h  

void UE::Learning::Array::Zero ( TLearningArrayView< InDimNum, InElementType > View,
const FIndexSet Indices
)

 Zero the memory of an array view LearningArray.h  

void UE::Learning::Array::Zero ( TLearningArray< InDimNum, InElementType, Allocator >& View,
const FIndexSet Indices
)

 Zero the memory of an array view LearningArray.h  

void UE::Learning::FrameSet::ParallelForEachFrame ( const FFrameSet& FrameSet,
const TFunctionRef< void(const int32 TotalFrameIdx, const int32 EntryIdx, const int32 RangeIdx)> Bod...
)

 Iterates over every frame in the set in parallel and calls the provided callback LearningFrameSet.h  

decltype(auto) UE::MultiArrayView::Private::GetDataHelper ( T&& Arg
)

 Copied from Core/Public/Containers/ArrayView.h MultiArrayView.h  
Copied from Core/Public/Containers/ArrayView.h MultiArrayView.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString UE::Learning::Array::FormatFloat ( const TLearningArrayView< 1, const float > Array,
const int32 MaxItemNum
)

   LearningArray.h  

static FString UE::Learning::Array::FormatInt32 ( const TLearningArrayView< 1, const int32 > Array,
const int32 MaxItemNum
)

   LearningArray.h  

static FString UE::Learning::Array::FormatUint64 ( const TLearningArrayView< 1, const uint64 > Array,
const int32 MaxItemNum
)

   LearningArray.h  

static void UE::Learning::DeserializeFromBytes ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
uint8& OutValue
)

 Deserialize an integer from bytes LearningArray.h  

static void UE::Learning::DeserializeFromBytes ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
int32& OutValue
)

 Deserialize an integer from bytes LearningArray.h  

static void UE::Learning::DeserializeFromBytes ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
int64& OutValue
)

 Deserialize an integer from bytes LearningArray.h  

static void UE::Learning::DeserializeFromBytes ( int64& InOutOffset,
TLearningArrayView< 1, const uint8 > Bytes,
uint64& OutValue
)

 Deserialize an integer from bytes LearningArray.h  

static void UE::Learning::SerializeToBytes ( int64& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const uint8 InValue
)

 Serialize an integer to bytes LearningArray.h  

static void UE::Learning::SerializeToBytes ( int64& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const int32 InValue
)

 Serialize an integer to bytes LearningArray.h  

static void UE::Learning::SerializeToBytes ( int64& InOutOffset,
TLearningArrayView< 1, uint8 > Bytes,
const int64 InValue
)

 Serialize an integer to bytes LearningArray.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page