- Schola Documentation
-
Examples
-
API Documentation
- Overview
-
Python API
-
Generated (gRPC)
-
C++ API (Unreal)
-
Classes
- Overview
- Class AGymConnectorManager
- Class ConstPointVisitor
- Class ConstSpaceVisitor
- Template Class ExchangeRPCWorker
- Class FCPUModelWrapper
- Class FCPURuntimeWrapper
- Class FGPUModelWrapper
- Class FGPURuntimeWrapper
- Class FSource/Schola/Editor/Module
- Class FSource/Schola/Imitation/Module
- Class FSource/Schola/InferenceUtils/Module
- Class FSource/Schola/Interactors/Module
- Class FScholaModule
- Class FSource/Schola/NNE/Module
- Class FSource/Schola/Protobuf/Module
- Class FSource/Schola/Training/Module
- Class IAgent
- Class IBaseImitationScholaEnvironment
- Class IBaseScholaEnvironment
- Template Class IConsumerBackend
- Template Class IExchangeBackend
- Class IGymConnector
- Class IImitationScholaEnvironment
- Class IModelInstanceInterface
- Class IModelInterface
- Class IMultiAgentImitationScholaEnvironment
- Class IMultiAgentScholaEnvironment
- Class IPolicy
- Template Class IProducerBackend
- Class IProtobufBackend
- Class IRuntimeInterface
- Class IScholaActuator
- Class IScholaEnvironment
- Class IScholaSensor
- Class ISingleAgentImitationScholaEnvironment
- Class ISingleAgentScholaEnvironment
- Class IStepper
- Class PointAllocator
- Class PointVisitor
- Template Class ProducerRPCWorker
- Class ProtobufPointDeserializer
- Class ProtobufPointSerializer
- Class ProtobufSpaceDeserializer
- Class ProtobufSpaceSerializer
- Template Class SpaceTransmuter
- Class SpaceVisitor
- Template Class TCallData
- Template Class TConsumerRPCBackend
- Template Class TConsumerRPCWorker
- Template Class TExchangeCallData
- Template Class TExchangeRPCBackend
- Template Class TImitationScholaEnvironment
- Template Class TProducerRPCBackend
- Template Class TRPCBackend
- Template Class TScholaEnvironment
- Class UAbstractGymConnector
- Class UAbstractImitationConnector
- Class UActionDebugLibrary
- Class UAgent
- Class UBaseImitationScholaEnvironment
- Class UBaseScholaEnvironment
- Class UBlueprintPolicy
- Class UBoxPointBlueprintLibrary
- Class UBoxSpaceBlueprintLibrary
- Class UCameraSensor
- Class UCommunicationManager
- Class UDictPointBlueprintLibrary
- Class UDictSpaceBlueprintLibrary
- Class UDiscretePointBlueprintLibrary
- Class UDiscreteSpaceBlueprintLibrary
- Class UExternalGymConnector
- Class UGymConnector
- Class ULaunchableScriptFunctionLibrary
- Class UManualGymConnector
- Class UMovementInputActuator
- Class UMultiAgentImitationScholaEnvironment
- Class UMultiAgentScholaEnvironment
- Class UMultiBinaryPointBlueprintLibrary
- Class UMultiBinarySpaceBlueprintLibrary
- Class UMultiDiscretePointBlueprintLibrary
- Class UMultiDiscreteSpaceBlueprintLibrary
- Class UNNEPolicy
- Class UPipelinedStepper
- Class UPointBlueprintLibrary
- Class UPolicy
- Class URPCGymConnector
- Class URPCImitationConnector
- Class URayCastSensor
- Class URotationActuator
- Class UScholaActuator
- Class UScholaSensor
- Class USimpleStepper
- Class USingleAgentImitationScholaEnvironment
- Class USingleAgentScholaEnvironment
- Class USpaceBlueprintLibrary
- Class UStepper
- Class UTeleportActuator
-
Structs
- Overview
- Struct FAgentState
- Struct FBoxPoint
- Struct FBoxSpace
- Struct FBoxSpaceDimension
- Struct FCustomTrainingSettings
- Struct FDictPoint
- Struct FDictSpace
- Struct FDiscretePoint
- Struct FDiscreteSpace
- Struct FEnvReset
- Struct FEnvStep
- Struct FEnvironmentDefinition
- Struct FEnvironmentState
- Struct FExternalGymConnectorSettings
- Struct FImitationAgentState
- Struct FImitationEnvironmentState
- Struct FImitationState
- Struct FImitationTrainingState
- Struct FInitialAgentState
- Struct FInitialEnvironmentState
- Struct FInitialState
- Struct FInteractionDefinition
- Struct FLaunchableScript
- Struct FLaunchableScriptRunnable
- Struct FMultiBinaryPoint
- Struct FMultiBinarySpace
- Struct FMultiDiscretePoint
- Struct FMultiDiscreteSpace
- Struct FNNEBindingCreator
- Struct FNNEBoxBuffer
- Struct FNNEBufferAllocator
- Struct FNNEBufferVisitor
- Struct FNNEDictBuffer
- Struct FNNEDiscreteBuffer
- Struct FNNEMultiBinaryBuffer
- Struct FNNEMultiDiscreteBuffer
- Struct FNNEPointBuffer
- Struct FNNEPointCreator
- Struct FNNEPointToBufferConverter
- Struct FNNEStateBuffer
- Struct FPoint
- Struct FRLlibAPPOSettings
- Struct FRLlibCheckpointSettings
- Struct FRLlibIMPALASettings
- Struct FRLlibLoggingSettings
- Struct FRLlibNetworkArchSettings
- Struct FRLlibPPOSettings
- Struct FRLlibResourceSettings
- Struct FRLlibResumeSettings
- Struct FRLlibTrainingSettings
- Struct FRPCServerSettings
- Struct FSB3CheckpointSettings
- Struct FSB3LoggingSettings
- Struct FSB3NetworkArchSettings
- Struct FSB3PPOSettings
- Struct FSB3ResumeSettings
- Struct FSB3SACSettings
- Struct FSB3TrainingSettings
- Struct FScriptArgBuilder
- Struct FScriptSettings
- Struct FSpace
- Struct FStartRequest
- Struct FTrainingDefinition
- Struct FTrainingReset
- Struct FTrainingSettings
- Struct FTrainingState
- Struct FTrainingStateUpdate
- Struct FTrainingStep
- Template Struct TBaseStructure< FPoint >
- Template Struct TBaseStructure< FSpace >
- UPipelinedStepper::FPipelinedStepperFrame
-
RewardCallback
Full path:
schola.scripts.sb3.utils.RewardCallback
schola.scripts.sb3.utils.RewardCallback
RewardCallback
RewardCallback(verbose=0, frequency=10, num_envs=1)Bases: CallbackList
Callback for logging rewards and steps taken by each environment in a multi-env setting.
Parameters
verbose (int, default=0)
: Verbosity level.
frequency (int, default=10)
: The frequency at which to log the rewards and steps taken.
num_envs (int, default=1)
: The number of environments to log rewards and steps for.
num_envs
num_envsThe number of environments to log rewards and steps for.
Type
- int
callbacks
callbacksThe list of RewardLoggingCallbacks for each environment.
Type
- List[SingleEnvRewardCallback]
summarize_every
summarize_everyThe frequency at which to log the rewards and steps taken.
Type
- int
curr_logging_interval
curr_logging_intervalThe current logging interval.
Type
- int
start_time
start_timeThe time at which the callback was created.
Type
- int
Methods
| Item | Description |
|---|---|
| init | — |
Attributes
| Item | Description |
|---|---|
| ready_to_log | Returns whether all environments are ready to log. |
init
__init__(verbose=0, frequency=10, num_envs=1)Parameters
verbose (int)
frequency (int)
num_envs (int)
ready_to_log
ready_to_log: boolReturns whether all environments are ready to log.