scripts.common

Full path: schola.scripts.common

schola.scripts.common

Common utility functions and classes for use in Schola scripts.

Functions

Item	Description
get_activation_function(activation)	Get the PyTorch activation function class for the specified activation type.

• schola.scripts.common.get_activation_function
• get_activation_function()

Classes

Item	Description
ActivationFunctionEnum(*values)	Activation functions for neural networks.
CheckpointArgs([enable_checkpoints, …])	Settings for checkpoints in Schola.
EnvironmentArgs([simulator, protocol])	Settings for the environment in Schola.
RLLibLauncherExtension()	—
Sb3LauncherExtension()	—
UnrealEditorSimulatorArgs()	Arguments for connecting to an existing Unreal Editor instance.
UnrealExecutableCommandLinePlaceholder()	A placeholder for the UnrealExecutableSimulatorArgs to allow for a default instantiation.
UnrealExecutableSimulatorArgs(executable_path)	Arguments for the Unreal Engine executable simulator in Schola.
gRPCProtocolArgs([port, url, …])	Settings for the gRPC protocol in Schola.

• schola.scripts.common.ActivationFunctionEnum

• ActivationFunctionEnum

• ActivationFunctionEnum.ReLU

• ActivationFunctionEnum.Sigmoid

• ActivationFunctionEnum.TanH

• schola.scripts.common.CheckpointArgs

• CheckpointArgs

• CheckpointArgs.init()

• CheckpointArgs.checkpoint_dir

• CheckpointArgs.enable_checkpoints

• CheckpointArgs.export_onnx

• CheckpointArgs.name_prefix_override

• CheckpointArgs.save_final_policy

• CheckpointArgs.save_freq

• schola.scripts.common.EnvironmentArgs

• EnvironmentArgs

• EnvironmentArgs.init()

• EnvironmentArgs.protocol

• EnvironmentArgs.simulator

• schola.scripts.common.RLLibLauncherExtension

• RLLibLauncherExtension

• RLLibLauncherExtension.init()

• RLLibLauncherExtension.get_extra_callbacks()

• schola.scripts.common.Sb3LauncherExtension

• Sb3LauncherExtension

• Sb3LauncherExtension.init()

• Sb3LauncherExtension.get_extra_KVWriters()

• Sb3LauncherExtension.get_extra_callbacks()

• schola.scripts.common.UnrealEditorSimulatorArgs

• UnrealEditorSimulatorArgs

• UnrealEditorSimulatorArgs.init()

• UnrealEditorSimulatorArgs.make()

• schola.scripts.common.UnrealExecutableCommandLinePlaceholder

• UnrealExecutableCommandLinePlaceholder

• UnrealExecutableCommandLinePlaceholder.init()

• UnrealExecutableCommandLinePlaceholder.executable_path

• UnrealExecutableCommandLinePlaceholder.make()

• schola.scripts.common.UnrealExecutableSimulatorArgs

• UnrealExecutableSimulatorArgs

• UnrealExecutableSimulatorArgs.init()

• UnrealExecutableSimulatorArgs.disable_script

• UnrealExecutableSimulatorArgs.display_logs

• UnrealExecutableSimulatorArgs.executable_path

• UnrealExecutableSimulatorArgs.fps

• UnrealExecutableSimulatorArgs.headless

• UnrealExecutableSimulatorArgs.make()

• UnrealExecutableSimulatorArgs.map

• schola.scripts.common.gRPCProtocolArgs

• gRPCProtocolArgs

• gRPCProtocolArgs.init()

• gRPCProtocolArgs.environment_start_timeout

• gRPCProtocolArgs.make()

• gRPCProtocolArgs.port

• gRPCProtocolArgs.url