- Schola Documentaion
- API Documentation
- python
- core
- schola.core
- schola.core.env
- schola.core.env.ScholaEnv
- schola.core.error_manager
- schola.core.error_manager.EnvironmentException
- schola.core.error_manager.MissingMethodError
- schola.core.error_manager.NoAgentsException
- schola.core.error_manager.NoEnvironmentsException
- schola.core.error_manager.NoServerError
- schola.core.error_manager.ScholaErrorContextManager
- schola.core.error_manager.ScholaException
- schola.core.error_manager.UnrealCrashedError
- schola.core.error_manager.WrappedGRPCException
- schola.core.spaces
- schola.core.spaces.base
- schola.core.spaces.base.get_space_shape_as_int
- schola.core.spaces.base.merge_space_shape
- schola.core.spaces.base.UnrealSpace
- schola.core.spaces.binary
- schola.core.spaces.binary.MultiBinarySpace
- schola.core.spaces.box
- schola.core.spaces.box.BoxSpace
- schola.core.spaces.dict
- schola.core.spaces.dict.DictSpace
- schola.core.spaces.discrete
- schola.core.spaces.discrete.DiscreteSpace
- schola.core.spaces.discrete.merge_discrete_like_spaces
- schola.core.spaces.discrete.MultiDiscreteSpace
- schola.core.unreal_connections
- schola.core.unreal_connections.StandaloneUnrealConnection
- schola.core.unreal_connections.UnrealConnection
- schola.core.unreal_connections.UnrealEditorConnection
- schola.core.utils
- schola.core.utils.get_plugins
- schola.core.utils.IdManager
- schola.core.utils.nested_get
- schola.core.utils.ScholaModel
- extensions
- schola_sb3
- schola.sb3
- schola.sb3.action_space_patch
- schola.sb3.action_space_patch.ActionSpacePatch
- schola.sb3.action_space_patch.HybridDistribution
- schola.sb3.action_space_patch.make_hybrid_dist
- schola.sb3.action_space_patch.patched_get_action_dim
- schola.sb3.action_space_patch.patched_with_norm
- schola.sb3.action_space_patch.PatchedPPO
- schola.sb3.action_space_patch.reshape_nonbatch
- schola.sb3.env
- schola.sb3.env.VecEnv
- schola.sb3.utils
- schola.sb3.utils.convert_ckpt_to_onnx_for_unreal
- schola.sb3.utils.get_scholasb3_model
- schola.sb3.utils.RenderImagesWrapper
- schola.sb3.utils.save_model_as_onnx
- schola.sb3.utils.SB3A2CModel
- schola.sb3.utils.SB3DDPGModel
- schola.sb3.utils.SB3DQNModel
- schola.sb3.utils.SB3PPOModel
- schola.sb3.utils.SB3SACModel
- schola.sb3.utils.SB3ScholaModel
- schola.sb3.utils.SB3TD3Model
- schola.sb3.utils.VecMergeDictActionWrapper
- generated
- schola.generated
- schola.generated.Definitions_pb2
- schola.generated.Definitions_pb2_grpc
- schola.generated.GymConnector_pb2
- schola.generated.GymConnector_pb2_grpc
- schola.generated.GymConnector_pb2_grpc.add_GymServiceServicer_to_server
- schola.generated.GymConnector_pb2_grpc.GymService
- schola.generated.GymConnector_pb2_grpc.GymServiceServicer
- schola.generated.GymConnector_pb2_grpc.GymServiceStub
- schola.generated.Points_pb2
- schola.generated.Points_pb2_grpc
- schola.generated.Spaces_pb2
- schola.generated.Spaces_pb2_grpc
- schola.generated.State_pb2
- schola.generated.State_pb2_grpc
- schola.generated.StateUpdates_pb2
- schola.generated.StateUpdates_pb2_grpc
- scripts
- schola.scripts
- schola.scripts.common
- schola.scripts.common.ActivationFunctionEnum
- schola.scripts.common.add_checkpoint_args
- schola.scripts.common.add_unreal_process_args
- schola.scripts.common.make_unreal_connection
- schola.scripts.common.RLLibLauncherExtension
- schola.scripts.common.Sb3LauncherExtension
- schola.scripts.common.ScriptArgs
- schola.scripts.ray
- schola.scripts.ray.launch
- schola.scripts.ray.launch.debug_main_from_cli
- schola.scripts.ray.launch.get_dataclass_args
- schola.scripts.ray.launch.main
- schola.scripts.ray.launch.main_from_cli
- schola.scripts.ray.launch.make_parser
- schola.scripts.ray.rllib_to_onnx
- schola.scripts.ray.rllib_to_onnx.make_parser
- schola.scripts.ray.settings
- schola.scripts.ray.settings.APPOSettings
- schola.scripts.ray.settings.IMPALASettings
- schola.scripts.ray.settings.LoggingSettings
- schola.scripts.ray.settings.NetworkArchitectureSettings
- schola.scripts.ray.settings.PPOSettings
- schola.scripts.ray.settings.ResourceSettings
- schola.scripts.ray.settings.ResumeSettings
- schola.scripts.ray.settings.RLLibAlgorithmSpecificSettings
- schola.scripts.ray.settings.RLlibScriptArgs
- schola.scripts.ray.settings.TrainingSettings
- schola.scripts.sb3
- schola.scripts.sb3.launch
- schola.scripts.sb3.launch.debug_main_from_cli
- schola.scripts.sb3.launch.get_dataclass_args
- schola.scripts.sb3.launch.main
- schola.scripts.sb3.launch.main_from_cli
- schola.scripts.sb3.launch.make_parser
- schola.scripts.sb3.sb3_to_onnx
- schola.scripts.sb3.sb3_to_onnx.make_parser
- schola.scripts.sb3.settings
- schola.scripts.sb3.settings.PPOSettings
- schola.scripts.sb3.settings.SACSettings
- schola.scripts.sb3.settings.SB3ScriptArgs
- schola.scripts.sb3.utils
- schola.scripts.sb3.utils.CustomProgressBarCallback
- schola.scripts.sb3.utils.RewardCallback
- schola.scripts.sb3.utils.SingleEnvRewardCallback
- schola.scripts.utils
- schola.scripts.utils.compile_proto
- schola.scripts.utils.compile_proto.disable_warnings
- schola.scripts.utils.compile_proto.fix_imports
- schola.scripts.utils.compile_proto.get_files
- schola.scripts.utils.compile_proto.get_generated_cpp_file_types
- schola.scripts.utils.compile_proto.get_generated_python_file_types
- schola.scripts.utils.compile_proto.get_proto_files
- schola.scripts.utils.compile_proto.main
- schola.scripts.utils.compile_proto.main_from_cli
- schola.scripts.utils.compile_proto.make_grpc_files
- schola.scripts.utils.compile_proto.make_parser
- schola.scripts.utils.compile_proto.make_proto_files
-
- unreal
- Documentation Index
- classes
- AAbstractScholaEnvironment
- AAbstractTrainer
- ABlueprintDynamicScholaEnvironment
- ABlueprintScholaEnvironment
- ABlueprintStaticScholaEnvironment
- ABlueprintTrainer
- ADynamicScholaEnvironment
- AInferenceController
- AInferencePawn
- AStaticScholaEnvironment
- CallData
- ConstPointVisitor
- ExchangeCallData
- ExchangeRPCBackend
- ExchangeRPCWorker
- FScholaModule
- IBinaryActuatorWrapper
- IBinaryObserverWrapper
- IBlueprintBinaryActuatorWrapper
- IBlueprintBinaryObserverWrapper
- IBlueprintBoxActuatorWrapper
- IBlueprintBoxObserverWrapper
- IBlueprintDiscreteActuatorWrapper
- IBlueprintDiscreteObserverWrapper
- IBoxActuatorWrapper
- IBoxObserverWrapper
- IBrainInterface
- IComBackendInterface
- IDiscreteActuatorWrapper
- IDiscreteObserverWrapper
- IExchangeBackendInterface
- IGymConnector
- IInferenceAgent
- IModelInstanceInterface
- IModelInterface
- IPollingBackendInterface
- IProducerBackendInterface
- IRuntimeInterface
- IValidatable
- PointSerializer
- PointVisitor
- PollingRPCBackend
- PollingRPCWorker
- ProducerRPCBackend
- ProducerRPCWorker
- ProtobufSerializer
- RPCBackend
- Singleton
- UAbstractBrain
- UAbstractEnvironmentUtilityComponent
- UAbstractGymConnector
- UAbstractInteractor
- UAbstractNormalizer
- UAbstractObserver
- UAbstractPolicy
- UActionClipper
- UActuator
- UActuatorComponent
- UAgentUIDSubsystem
- UAsyncBrain
- UBTTask_AgentStep
- UBinaryActuator
- UBinaryActuatorWrapper
- UBinaryObserver
- UBinaryObserverWrapper
- UBlueprintBinaryActuator
- UBlueprintBinaryActuatorWrapper
- UBlueprintBinaryObserver
- UBlueprintBinaryObserverWrapper
- UBlueprintBoxActuator
- UBlueprintBoxActuatorWrapper
- UBlueprintBoxObserver
- UBlueprintBoxObserverWrapper
- UBlueprintDiscreteActuator
- UBlueprintDiscreteActuatorWrapper
- UBlueprintDiscreteObserver
- UBlueprintDiscreteObserverWrapper
- UBlueprintEnvironmentUtilityComponent
- UBlueprintPolicy
- UBoxActuator
- UBoxActuatorWrapper
- UBoxObserver
- UBoxObserverWrapper
- UBrainInterface
- UCPUModelWrapper
- UCPURuntimeWrapper
- UCameraObserver
- UCommunicationManager
- UDebugBinaryActuator
- UDebugBinaryObserver
- UDebugBoxActuator
- UDebugBoxObserver
- UDebugDiscreteActuator
- UDebugDiscreteObserver
- UDiscreteActuator
- UDiscreteActuatorWrapper
- UDiscreteBrain
- UDiscreteObserver
- UDiscreteObserverWrapper
- UEventObserver
- UExternalGymConnector
- UFrameStacker
- UGPUModelWrapper
- UGPURuntimeWrapper
- UGymConnector
- UHardNormalizer
- UInferenceAgent
- UInferenceComponent
- UInferencePolicy
- UInteractionComponent
- UInteractionManager
- UModelInstanceWrapper
- UMovementInputActuator
- UObservationClipper
- UPositionObserver
- UPythonGymConnector
- URayCastObserver
- URotationActuator
- URotationObserver
- UScholaManagerSubsystem
- UScholaManagerSubsystemSettings
- USensor
- UStatLoggerComponent
- USynchronousBrain
- UTeleportActuator
- UValidatable
- UVelocityObserver
- structs
- FActTickFunction
- FAction
- FAgentId
- FBinaryPoint
- FBinarySpace
- FBoxPoint
- FBoxSpace
- FBoxSpaceDimension
- FCommunicatorSettings
- FCustomTrainingSettings
- FDictPoint
- FDictSpace
- FDiscretePoint
- FDiscreteSpace
- FDynamicAgentStruct
- FEnvReset
- FEnvStep
- FEnvUpdate
- FEnvironmentDefinition
- FGenericTensorBinding
- FInferencePolicyBuffer
- FInteractionDefinition
- FLaunchableScript
- FPoint
- FPolicyDecision
- FRLlibAPPOSettings
- FRLlibCheckpointSettings
- FRLlibIMPALASettings
- FRLlibLoggingSettings
- FRLlibNetworkArchSettings
- FRLlibPPOSettings
- FRLlibResourceSettings
- FRLlibResumeSettings
- FRLlibTrainingSettings
- FSB3CheckpointSettings
- FSB3LoggingSettings
- FSB3NetworkArchSettings
- FSB3PPOSettings
- FSB3ResumeSettings
- FSB3SACSettings
- FSB3TrainingSettings
- FScriptArgBuilder
- FScriptSettings
- FSharedEnvironmentDefinition
- FSharedEnvironmentState
- FSharedTrainingDefinition
- FSpace
- FStartRequest
- FThinkTickFunction
- FTrainerAgentPair
- FTrainerConfiguration
- FTrainerDefinition
- FTrainerState
- FTrainingDefinition
- FTrainingSettings
- FTrainingState
- FTrainingStateUpdate
- FValidationResult
- TStructOpsTypeTraits<FActTickFunction>
- TStructOpsTypeTraits<FThinkTickFunction>
- UModelInstanceWrapper::FBindingTypeExtractor
- UModelInstanceWrapper::FBindingTypeExtractor<UE::NNE::EResultStatus(T::*)(TConstArrayView<BindingType>, TConstArrayView<BindingType>)>
-
FTrainingState
struct FTrainingState
A Struct representing the state of the training session given by a set of EnvironmentStates.
Dependencies: FSharedEnvironmentState
Public Interface
Constructor:
FTrainingState
inline FTrainingState()
Attributes: inline
Source: Schola/Source/Schola/Public/Training/StateStructs/TrainingState.h
(line 24, column 1)
Public Functions:
ToProto
inline Schola::TrainingState * ToProto() const const
Convert this object to a protobuf message (Schola::TrainingState)
Returns: A new protobuf message containing the contents of this object
Returns: Schola::TrainingState *
Attributes: const
, inline
Source: Schola/Source/Schola/Public/Training/StateStructs/TrainingState.h
(line 30, column 23)
ToResetProto
inline Schola::InitialTrainingState * ToResetProto(const TArray<int> &TargetEnvironments) const const
Convert this object to a protobuf message (Schola::InitialTrainingState) representing the initial state of a subset of environments after a reset.
Returns: A new protobuf message containing the initial state of the specified environments
Parameters:
TargetEnvironments
(const TArray<int> &
) – [in] The list of environment ids to include in the message
Returns: Schola::InitialTrainingState *
Attributes: const
, inline
Source: Schola/Source/Schola/Public/Training/StateStructs/TrainingState.h
(line 47, column 30)
Public Members:
TArray<FSharedEnvironmentState> EnvironmentStates
TArray<FSharedEnvironmentState> EnvironmentStates
Map from EnvironmentId to EnvironmentState.
Source: Schola/Source/Schola/Public/Training/StateStructs/TrainingState.h
(line 22, column 8)
Used By: UAbstractGymConnector, UExternalGymConnector, UPythonGymConnector
Source: Schola/Source/Schola/Public/Training/StateStructs/TrainingState.h
(line 17, column 1)