Skip to content

schola.scripts.common.ScriptArgs

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

Methods

__init__([enable_checkpoints, …])
make_unreal_connection()Create an Unreal Engine connection based on the script arguments.

Attributes

checkpoint_dirEnable saving checkpoints.
disable_scriptFlag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled.
enable_checkpointsEnable saving checkpoints
executable_pathPath to the standalone executable, when launching a standalone Environment
export_onnxWhether to export the model to ONNX format instead of just saving a checkpoint.
fpsFixed FPS to use when running standalone, if None no fixed timestep is used
headlessFlag indicating if the standalone Unreal Engine process should run in headless mode
launch_unrealFlag indicating if the script should launch a standalone Unreal Engine process
mapMap to load when launching a standalone Unreal Engine process
name_prefix_overrideOverride the name prefix for the checkpoint files (e.g. SAC, PPO, etc.).
portPort to connect to the Unreal Engine process, if None an open port will be automatically selected when running standalone.
save_final_policyWhether to save the final policy after training is complete.
save_freqFrequency with which to save checkpoints.

Parameters: : - enable_checkpoints (bool)

  • checkpoint_dir (str)
  • save_freq (int)
  • name_prefix_override (str)
  • export_onnx (bool)
  • save_final_policy (bool)
  • launch_unreal (bool)
  • port (int | None)
  • executable_path (str | None)
  • headless (bool)
  • map (str | None)
  • fps (int | None)
  • disable_script (bool)

__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) : Parameters: : - enable_checkpoints (bool)

  • checkpoint_dir (str)
  • save_freq (int)
  • name_prefix_override (str | None)
  • export_onnx (bool)
  • save_final_policy (bool)
  • launch_unreal (bool)
  • port (int | None)
  • executable_path (str | None)
  • headless (bool)
  • map (str | None)
  • fps (int | None)
  • disable_script (bool)

Return type: : None

checkpoint_dir*: str* = ’./ckpt’ : Enable saving checkpoints.

disable_script*: bool* = False : Flag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled. Useful for testing.

enable_checkpoints*: bool* = False : Enable saving checkpoints

executable_path*: str | None* = None : Path to the standalone executable, when launching a standalone Environment

export_onnx*: bool* = False : Whether to export the model to ONNX format instead of just saving a checkpoint.

fps*: int | None* = None : Fixed FPS to use when running standalone, if None no fixed timestep is used

headless*: bool* = False : Flag indicating if the standalone Unreal Engine process should run in headless mode

launch_unreal*: bool* = False : Flag indicating if the script should launch a standalone Unreal Engine process

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

map*: str | None* = None : Map to load when launching a standalone Unreal Engine process

name_prefix_override*: str* = None : Override the name prefix for the checkpoint files (e.g. SAC, PPO, etc.)

port*: int | None* = 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*: bool* = False : Whether to save the final policy after training is complete.

save_freq*: int* = 100000 : Frequency with which to save checkpoints.