schola.scripts.common.ScriptArgs
Class Definition
class schola.scripts.common.ScriptArgs(enable_checkpoints=False, checkpoint_dir='./ckpt', save_freq=100000, name_prefix_override=None, export_onnx=False, save_final_policy=False, launch_unreal=False, port=None, executable_path=None, headless=False, map=None, fps=None, disable_script=False)Bases: object
Arguments for included scripts
Parameters
enable_checkpoints
Type: bool
checkpoint_dir
Type: str
save_freq
Type: int
name_prefix_override
Type: str | None
export_onnx
Type: bool
save_final_policy
Type: bool
launch_unreal
Type: bool
port
Type: int | None
executable_path
Type: str | None
headless
Type: bool
map
Type: str | None
fps
Type: int | None
disable_script
Type: bool
Attributes
checkpoint_dir
Type: str
Default: './ckpt'
Enable saving checkpoints.
disable_script
Type: bool
Default: False
Flag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled. Useful for testing.
enable_checkpoints
Type: bool
Default: False
Enable saving checkpoints
executable_path
Type: str | None
Default: None
Path to the standalone executable, when launching a standalone Environment
export_onnx
Type: bool
Default: False
Whether to export the model to ONNX format instead of just saving a checkpoint.
fps
Type: int | None
Default: None
Fixed FPS to use when running standalone, if None no fixed timestep is used
headless
Type: bool
Default: False
Flag indicating if the standalone Unreal Engine process should run in headless mode
launch_unreal
Type: bool
Default: False
Flag indicating if the script should launch a standalone Unreal Engine process
map
Type: str | None
Default: None
Map to load when launching a standalone Unreal Engine process
name_prefix_override
Type: str
Default: None
Override the name prefix for the checkpoint files (e.g. SAC, PPO, etc.)
port
Type: int | None
Default: None
Port to connect to the Unreal Engine process, if None an open port will be automatically selected when running standalone. Port is required if connecting to an existing Unreal Engine process.
save_final_policy
Type: bool
Default: False
Whether to save the final policy after training is complete.
save_freq
Type: int
Default: 100000
Frequency with which to save checkpoints.
Methods
__init__
__init__(enable_checkpoints=False, checkpoint_dir='./ckpt', save_freq=100000, name_prefix_override=None, export_onnx=False, save_final_policy=False, launch_unreal=False, port=None, executable_path=None, headless=False, map=None, fps=None, disable_script=False)Return type: None
make_unreal_connection
make_unreal_connection()Create an Unreal Engine connection based on the script arguments.
Returns: The Unreal Engine connection to use for the script.
Return type: UnrealConnection