Skip to content

schola-sb3 Command

This script trains Stable Baselines3 models using Schola with various configuration options for training, checkpointing, and network architecture.

Usage

Terminal window
usage: schola-sb3 [-h] [--launch-unreal] [--executable-path EXECUTABLE_PATH] [--headless] [-p PORT] [--map MAP] [--fps FPS] [--disable-script]
                  [-scholav SCHOLA_VERBOSITY] [--enable-checkpoints] [--checkpoint-dir CHECKPOINT_DIR] [--save-freq SAVE_FREQ] [--name-prefix NAME_PREFIX]
                  [--export-onnx] [--save-final-policy] [--save-replay-buffer] [--save-vecnormalize] [--resume-from RESUME_FROM] [--load-vecnormalize LOAD_VECNORMALIZE]
                  [--load-replay-buffer LOAD_REPLAY_BUFFER] [--reset-timestep] [--policy-parameters POLICY_PARAMETERS [POLICY_PARAMETERS ...]]
                  [--critic-parameters CRITIC_PARAMETERS [CRITIC_PARAMETERS ...]]
                  {PPO,SAC} ...

Optional Arguments

Standard command-line arguments for the schola-sb3 script.

Unreal Process Arguments

  • --launch-unreal - Launch Unreal Engine automatically

  • Default: False

  • Required: False

  • --executable-path - Path to the Unreal Engine executable

  • Type: str

  • Required: False

  • --headless - Run Unreal Engine in headless mode

  • Default: False

  • Required: False

  • -p, --port - Port for Unreal Engine communication

  • Default: 15151

  • Type: int

  • Required: False

  • --map - Map to load in Unreal Engine

  • Type: str

  • Required: False

  • --fps - Target FPS for Unreal Engine

  • Default: 60

  • Type: int

  • Required: False

  • --disable-script - Disable script execution in Unreal Engine

  • Default: False

  • Required: False

Logging Arguments

  • -scholav, --schola-verbosity - Verbosity level for the Schola environment
  • Default: 0
  • Type: int
  • Required: False

Checkpoint Arguments

  • --enable-checkpoints - Enable saving checkpoints

  • Default: False

  • Required: False

  • --checkpoint-dir - Directory to save checkpoints

  • Default: './ckpt'

  • Type: str

  • Required: False

  • --save-freq - Frequency with which to save checkpoints

  • Default: 100000

  • Type: int

  • Required: False

  • --name-prefix - Override the name prefix for the checkpoint files (e.g. SAC, PPO, etc.)

  • Type: str

  • Required: False

  • --export-onnx - Whether to export the model to ONNX format instead of just saving a checkpoint

  • Default: False

  • Required: False

  • --save-final-policy - Whether to save the final policy after training is complete

  • Default: False

  • Required: False

  • --save-replay-buffer - Save the replay buffer during training, if saving checkpoints

  • Default: False

  • Required: False

  • --save-vecnormalize - Save the VecNormalize parameters during training, if saving checkpoints

  • Default: False

  • Required: False

Resume Arguments

  • --resume-from - Path to a saved model to resume training from

  • Type: str

  • Required: False

  • --load-vecnormalize - Path to a saved VecNormalize parameters to load, if resuming from a checkpoint

  • Type: str

  • Required: False

  • --load-replay-buffer - Path to a saved Replay Buffer to load, if resuming from a checkpoint

  • Type: str

  • Required: False

  • --reset-timestep - Reset the timestep counter to 0 when resuming from a checkpoint

  • Default: False

  • Required: False

Network Architecture Arguments

  • --policy-parameters - Network architecture for the policy

  • Type: int (multiple values allowed)

  • Required: False

  • --critic-parameters - Network architecture for the critic

  • Type: int (multiple values allowed)

  • Required: False

Sub-commands

PPO

Proximal Policy Optimization algorithm for Stable Baselines3.

Optional Arguments

  • Algorithm-specific arguments for PPO configuration

SAC

Soft Actor-Critic algorithm for Stable Baselines3.

Optional Arguments

  • Algorithm-specific arguments for SAC configuration