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&40;Abstract, BlueprintType, Blueprintable&41;  
class ULearningAgentsInteractor : public ULearningAgentsManagerComponent

Remarks

ULearningAgentsInteractor defines how agents interact with the environment through their observations and actions. Additionally, it provides methods to be called during the inference process of those agents.

To use this class, you need to implement the SetupObservations and SetupActions functions (as well as their corresponding SetObservations and SetActions functions), which will define the size of inputs and outputs to your policy. Before you can do inference, you need to call SetupInteractor, which will initialize the underlying data structure, and you need to call AddAgent for each object you want controlled by this agent interactor.

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 void Used by objects derived from ULearningAgentsAction to add themselves to this agent interactor during their creation.
Public function void Used by objects derived from ULearningAgentsObservation to add themselves to this agent interactor during their creation.
Public function void Decode Actions for a specific set of agents
Public function UFunction BlueprintCallable, Category void Call this function when it is time for your agents to take their actions.
Public function void Encode Observations for a specific set of agents
Public function UFunction BlueprintCallable, Category void Encoding / Decoding
Public function TLearningArrayView< 1, uint64 > Get the number of times actions have been encoded for all agents
Public function Const UE::Learning::FFeatureObject & Get a reference to this agent interactor's action feature.
Public function Const TConstArrayView< ULearningAgentsAction * > Get a const array view of this agent interactor's action objects.
Public function UFunction Category blueprintnativeevent void

GetActions ( const TArray< int32 >& AgentIds
)

 During this event, you should retrieve the actions and apply them to your agents.
Public function Const UFunction BlueprintPure, Category, Meta void

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

 Gets the action vector used by a given agent.
Public function TLearningArrayView< 1, uint64 > Get the number of times observations have been encoded for all agents
Public function Const UE::Learning::FFeatureObject & Non-blueprint public interface
Public function Const TConstArrayView< ULearningAgentsObservation * > Get a const array view of this agent interactor's observation objects.
Public function Const UFunction BlueprintPure, Category, Meta void

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

 Gets the observation vector used by a given agent. Should be called only after EncodeObservations.
Public function UFunction Category blueprintnativeevent void

SetObservations ( const TArray< int32 >& AgentIds
)

 During this event, all observations should be set for each agent.
Public function UFunction Category blueprintnativeevent void Actions
Public function UFunction BlueprintCallable, Category void Initializes this object and runs the setup events for observations and actions.
Public function UFunction Category blueprintnativeevent void Observations

Overridden from ULearningAgentsManagerComponent

  Type Name Description
Public function Virtual void

OnAgentsAdded ( const TArray< int32 >& AgentIds
)

 Called whenever agents are added to the parent ALearningAgentsManager object.
Public function Virtual void

OnAgentsRemoved ( const TArray< int32 >& AgentIds
)

 Called whenever agents are removed from the parent ALearningAgentsManager object.
Public function Virtual void

OnAgentsReset ( const TArray< int32 >& AgentIds
)

 Called whenever agents are reset on the parent ALearningAgentsManager object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page