Navigation
API > API/Plugins > API/Plugins/Learning
Observation Schema
This object allows you to construct a description of the kind of observations you might want to provide as input to a policy. Internally this object contains a pool of individual elements. This allows them to be constructed performantly and in a cache efficient way. This object is therefore required to access any data about the individual observation elements that are created.
| Name | FSchema |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/LearningAgents/Source/Learning/Public/LearningObservation.h |
| Include Path | #include "LearningObservation.h" |
Syntax
struct FSchema
Inheritance Hierarchy
- FSchema
- FSchemaBase → FSchema
Structs
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AndData | TArray< FAndData > | LearningObservation.h | ||
| ArrayData | TArray< FArrayData > | LearningObservation.h | ||
| ContinuousData | TArray< FContinuousData > | These are indexed based on the Type using TypeDataIndices | LearningObservation.h | |
| Conv1dData | TArray< FConv1dData > | LearningObservation.h | ||
| Conv2dData | TArray< FConv2dData > | LearningObservation.h | ||
| DiscreteExclusiveData | TArray< FDiscreteExclusiveData > | LearningObservation.h | ||
| DiscreteInclusiveData | TArray< FDiscreteInclusiveData > | LearningObservation.h | ||
| EncodedVectorSizes | TArray< int32 > | LearningObservation.h | ||
| EncodingData | TArray< FEncodingData > | LearningObservation.h | ||
| Generation | uint32 | LearningObservation.h | ||
| NamedDiscreteExclusiveData | TArray< FNamedDiscreteExclusiveData > | LearningObservation.h | ||
| NamedDiscreteInclusiveData | TArray< FNamedDiscreteInclusiveData > | LearningObservation.h | ||
| ObservationDistributionVectorSizes | TArray< int32 > | LearningObservation.h | ||
| ObservationVectorSizes | TArray< int32 > | LearningObservation.h | ||
| OrExclusiveData | TArray< FOrExclusiveData > | LearningObservation.h | ||
| OrInclusiveData | TArray< FOrInclusiveData > | LearningObservation.h | ||
| SetData | TArray< FSetData > | LearningObservation.h | ||
| SubElementNames | TArray< FName > | This is an array of all the SubElements and their names, referenced by other elements | LearningObservation.h | |
| SubElementObjects | TArray< FSchemaElement > | LearningObservation.h | ||
| Tags | TArray< FName > | LearningObservation.h | ||
| TypeDataIndices | TArray< int32 > | LearningObservation.h | ||
| Types | TArray< EType > | These have entries for each Schema Element | LearningObservation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSchemaElement CreateAnd
(
const FSchemaAndParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateArray
(
const FSchemaArrayParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateContinuous
(
const FSchemaContinuousParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateConv1d
(
const FSchemaConv1dParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateConv2d
(
const FSchemaConv2dParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateDiscreteExclusive
(
const FSchemaDiscreteExclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateDiscreteInclusive
(
const FSchemaDiscreteInclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateEncoding
(
const FSchemaEncodingParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateNamedDiscreteExclusive
(
const FSchemaNamedDiscreteExclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateNamedDiscreteInclusive
(
const FSchemaNamedDiscreteInclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateNull
(
const FName Tag |
LearningObservation.h | ||
FSchemaElement CreateOrExclusive
(
const FSchemaOrExclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateOrInclusive
(
const FSchemaOrInclusiveParameters Parameters, |
LearningObservation.h | ||
FSchemaElement CreateSet
(
const FSchemaSetParameters Parameters, |
LearningObservation.h | ||
void Empty() |
Empty all internal buffers of elements. This invalidates all existing elements. | LearningObservation.h | |
FSchemaAndParameters GetAnd
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaArrayParameters GetArray
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaContinuousParameters GetContinuous
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaConv1dParameters GetConv1d
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaConv2dParameters GetConv2d
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaDiscreteExclusiveParameters GetDiscreteExclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaDiscreteInclusiveParameters GetDiscreteInclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
int32 GetEncodedVectorSize
(
const FSchemaElement Element |
Get the encoded vector size of the given element. | LearningObservation.h | |
FSchemaEncodingParameters GetEncoding
(
const FSchemaElement Element |
LearningObservation.h | ||
uint32 GetGeneration() |
Get the current generation. | LearningObservation.h | |
FSchemaNamedDiscreteExclusiveParameters GetNamedDiscreteExclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaNamedDiscreteInclusiveParameters GetNamedDiscreteInclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
int32 GetObservationDistributionVectorSize
(
const FSchemaElement Element |
Get the observation distribution vector size of the given element. | LearningObservation.h | |
int32 GetObservationVectorSize
(
const FSchemaElement Element |
Get the observation vector size of the given element. | LearningObservation.h | |
FSchemaOrExclusiveParameters GetOrExclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaOrInclusiveParameters GetOrInclusive
(
const FSchemaElement Element |
LearningObservation.h | ||
FSchemaSetParameters GetSet
(
const FSchemaElement Element |
LearningObservation.h | ||
FName GetTag
(
const FSchemaElement Element |
Gets the tag of the given element. | LearningObservation.h | |
EType GetType
(
const FSchemaElement Element |
Gets the type of the given element. | LearningObservation.h | |
bool IsEmpty() |
Checks if the given schema is empty of elements. | LearningObservation.h | |
bool IsValid
(
const FSchemaElement Element |
Checks if the given element is valid. | LearningObservation.h | |
void Reset() |
Reset all internal buffers (without freeing memory). This invalidates all existing elements. | LearningObservation.h |