1. Epic GamesDeveloper
  3. ULearningAgentsInteractor

ULearningAgentsInteractor

[ULearningAgentsInteractor](API\Plugins\LearningAgents\ULearningAgentsInteractor) defines how agents interact with the environment through their observations and actions.

API > API/Plugins > API/Plugins/LearningAgents

Inheritance Hierarchy

References

   
Module LearningAgents
Header /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgents/Public/LearningAgentsInteractor.h
Include #include "LearningAgentsInteractor.h"

Syntax

UCLASS (Abstract, HideDropDown, BlueprintType, Blueprintable)  
class ULearningAgentsInteractor : public ULearningAgentsManagerListener

Remarks

ULearningAgentsInteractor defines how agents interact with the environment through their observations and actions.

To use this class, you need to implement SpecifyAgentObservation_ and SpecifyAgentAction_, which will define the structure of inputs and outputs to your policy. You also need to implement GatherAgentObservation_ and PerformAgentAction_ which will dictate how those observations are gathered, and actions actuated in your environment.

Constructors

  Type Name Description
Public function   These constructors/destructors are needed to make forward declarations happy.
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UFunction Category, Meta blueprintnativeevent void

GatherAgentObservation ( FLearningAgentsObservationObjectElement& OutObservationObjectElement,
ULearningAgentsObservationObject* InObservationObject,
const int32 AgentId
)

 This callback should be overridden by the Interactor and gathers the observations for a single agent.
Public function UFunction Category, Meta blueprintnativeevent void

GatherAgentObservations ( TArray< FLearningAgentsObservationObjectElement >& OutObservationObjectElements,
ULearningAgentsObservationObject* InObservationObject,
const TArray< int32 >& AgentIds
)

 This callback can be overridden by the Interactor and gathers all the observations for the given agents.
Public function void

GatherObservations ( const UE::Learning::FIndexSet AgentSet,
bool bIncrementIteration
)

 -- Non-blueprint public interface --
Public function UFunction BlueprintCallable, Category void -- Blueprint public interface --
Public function Const UFunction BlueprintPure, Category int32 Gets the size of the action distribution vector used by this interactor.
Public function Const UFunction BlueprintPure, Category int32 Gets the size of the encoded action vector used by this interactor.
Public function Const uint64

GetActionIteration ( const int32 AgentId
)

 Gets the action iteration value for the given agent id.
Public function ULearningAgentsActionObject * Gets the action object.
Public function TArray< FLearningAgentsActionObjectElement > & Gets the action object elements.
Public function Const const ULearningAgentsActionSchema * Gets the action schema object
Public function Const const FLearningAgentsActionSchemaElement Gets the action schema element
Public function UFunction BlueprintCallable, Category, Meta void

GetActionVector ( TArray< float >& OutActionVector,
int32& OutActionCompatibilityHash,
const int32 AgentId
)

 Get the current buffered action vector for the given agent.
Public function Const TLearningArrayView< 2, const float > Gets the action vectors as a const array view.
Public function TLearningArrayView< 1, uint64 > Gets the action vector iterations as a mutable array view.
Public function TLearningArrayView< 2, float > Gets the action vectors as a mutable array view.
Public function Const UFunction BlueprintPure, Category int32 Gets the size of the action vector used by this interactor.
Public function Const UFunction BlueprintPure, Category int32 Gets the size of the encoded observation vector used by this interactor.
Public function Const uint64

GetObservationIteration ( const int32 AgentId
)

 Gets the observation iteration value for the given agent id.
Public function Const const ULearningAgentsObservationObject * Gets the observation object.
Public function Const const TArray< FLearningAgentsObservationObjectElement > & Gets the observation object elements.
Public function Const const ULearningAgentsObservationSchema * Gets the observation schema object
Public function Const const FLearningAgentsObservationSchemaElement Gets the observation schema element
Public function UFunction BlueprintCallable, Category, Meta void

GetObservationVector ( TArray< float >& OutObservationVector,
int32& OutObservationCompatibilityHash,
const int32 AgentId
)

 Get the current buffered observation vector for the given agent.
Public function Const TLearningArrayView< 2, const float > Gets the observation vectors as a const array view.
Public function Const UFunction BlueprintPure, Category int32 Gets the size of the observation vector used by this interactor.
Public function Const UFunction BlueprintPure, Category, Meta bool

HasActionVector ( const int32 AgentId
)

 Returns true if DecodeAndSampleActions on the policy or SetActionVector has been called and the action vector already set for the given agent.
Public function Const UFunction BlueprintPure, Category, Meta bool

HasObservationVector ( const int32 AgentId
)

 Returns true if GatherObservations or SetObservationVector has been called and the observation vector already set for the given agent.
Public function Static UFunction BlueprintCallable, Category, Meta ULearningAgentsInteractor * Constructs an Interactor.
Public function Virtual void

OnAgentsAdded_Implementation ( const TArray< int32 >& AgentIds
)

  
Public function Virtual void  
Public function Virtual void

OnAgentsReset_Implementation ( const TArray< int32 >& AgentIds
)

  
Public function void Perform Actions for a specific set of agents
Public function UFunction BlueprintCallable, Category void Performs all the actions for all agents. This will call PerformAgentActions.
Public function UFunction Category, Meta blueprintnativeevent void

PerformAgentAction ( const ULearningAgentsActionObject* InActionObject,
const FLearningAgentsActionObjectElement& InActionObjectElement,
const int32 AgentId
)

 This callback should be overridden by the Interactor and performs the action for the given agent in the world.
Public function UFunction Category, Meta blueprintnativeevent void

PerformAgentActions ( const ULearningAgentsActionObject* InActionObject,
const TArray< FLearningAgentsActionObjectElement >& InActionObjectElements,
const TArray< int32 >& AgentIds
)

 This callback can be overridden by the Interactor and performs all the actions for the given agents in the world.
Public function UFunction BlueprintCallable, Category, Meta void

SetActionVector ( const TArray< float >& ActionVector,
const int32 InActionCompatibilityHash,
const int32 AgentId,
bool bIncrementIteration
)

 Sets the current buffered action vector for the given agent.
Public function UFunction BlueprintCallable, Category, Meta void

SetObservationVector ( const TArray< float >& ObservationVector,
const int32 InObservationCompatibilityHash,
const int32 AgentId,
bool bIncrementIteration
)

 Sets the current buffered observation vector for the given agent.
Public function UFunction BlueprintCallable, Category void Initializes an Interactor.
Public function UFunction Category, Meta blueprintnativeevent void -- Actions --
Public function UFunction Category, Meta blueprintnativeevent void -- Observations --

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page