Skip to content

Class IImitationScholaEnvironment

Class IImitationScholaEnvironment

  • Defined in File ImitationEnvironmentInterface.h

Inheritance Relationships

Derived Type

class IImitationScholaEnvironment

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Dependencies: FImitationAgentState, FInitialAgentState, FInteractionDefinition

A type-erased interface for a variety of Schola Environments (single and multi agent)

This interface provides a common abstraction for both single-agent and multi-agent imitation learning environments, allowing them to be managed uniformly.

Subclassed by TImitationScholaEnvironment< T >


Public Functions

SymbolDetails
InitializeEnvironmentInitialize the environment and retrieve agent definitions.
SeedEnvironmentSet the random seed for the environment.
SetEnvironmentOptionsConfigure environment options.
ResetReset the environment to its initial state.
StepExecute one step of the environment with expert demonstrations.
~IImitationScholaEnvironmentVirtual destructor for proper cleanup.

InitializeEnvironment

virtual void InitializeEnvironment(
TMap<FString, FInteractionDefinition> &OutAgentDefinitions) = 0

Initialize the environment and retrieve agent definitions.

Parameters

OutAgentDefinitions – [out] Map of agent names to their interaction definitions

#DirectionNameTypeDescription
1OutAgentDefinitionsTMap< FString, FInteractionDefinition > &Map of agent names to their interaction definitions

Attributes: pure virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

SeedEnvironment

virtual void SeedEnvironment(int Seed) = 0

Set the random seed for the environment.

Parameters

Seed – [in] The random seed value

#DirectionNameTypeDescription
1SeedintThe random seed value

Attributes: pure virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

SetEnvironmentOptions

virtual void SetEnvironmentOptions(const TMap<FString, FString> &Options) = 0

Configure environment options.

Parameters

Options – [in] Map of option names to their string values

#DirectionNameTypeDescription
1Optionsconst TMap< FString, FString > &Map of option names to their string values

Attributes: pure virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Reset

virtual void Reset(TMap<FString, FInitialAgentState> &OutAgentState) = 0

Reset the environment to its initial state.

Parameters

OutAgentState – [out] Map of agent names to their initial states

#DirectionNameTypeDescription
1OutAgentStateTMap< FString, FInitialAgentState > &Map of agent names to their initial states

Attributes: pure virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Step

virtual void Step(TMap<FString, FImitationAgentState> &OutAgentStates) = 0

Execute one step of the environment with expert demonstrations.

Parameters

OutAgentStates – [out] Map of agent names to their imitation states (observations, actions, rewards)

#DirectionNameTypeDescription
1OutAgentStatesTMap< FString, FImitationAgentState > &Map of agent names to their imitation states (observations, actions, rewards)

Attributes: pure virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h


~IImitationScholaEnvironment

virtual ~IImitationScholaEnvironment() = default

Virtual destructor for proper cleanup.

Attributes: virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h