Sb3LoggingArgs

Full path: schola.scripts.sb3.settings.Sb3LoggingArgs

schola.scripts.sb3.settings.Sb3LoggingArgs

Sb3LoggingArgs

Sb3LoggingArgs(
    enable_tensorboard=False,
    log_dir=WindowsPath("logs"),
    log_freq=10,
    callback_verbosity=0,
    schola_verbosity=0,
    sb3_verbosity=1,
)

Bases: object

Dataclass for configuring logging settings for the training process.

Methods

Item	Description
init	—

Attributes

Item	Description
callback_verbosity	Verbosity level for callbacks.
enable_tensorboard	Whether to enable TensorBoard logging.
log_dir	Directory to save TensorBoard logs.
log_freq	Frequency of logging training metrics to TensorBoard.
sb3_verbosity	Verbosity level for Stable Baselines3 logging.
schola_verbosity	Verbosity level for Schola-specific logging.

Parameters

enable_tensorboard (bool)

log_dir (Annotated[Path, Parameter(validator=(Path(exists=False, file_okay=False, dir_okay=True, ext=()),))])

log_freq (Annotated[int, Parameter(validator=(Number(lt=None, lte=None, gt=None, gte=0, modulo=None),))])

callback_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

schola_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

sb3_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

init

__init__(
    enable_tensorboard=False,
    log_dir=WindowsPath("logs"),
    log_freq=10,
    callback_verbosity=0,
    schola_verbosity=0,
    sb3_verbosity=1,
)

Parameters

enable_tensorboard (bool)

log_dir (Annotated[Path, Parameter(validator=(Path(exists=False, file_okay=False, dir_okay=True, ext=()),))])

log_freq (Annotated[int, Parameter(validator=(Number(lt=None, lte=None, gt=None, gte=0, modulo=None),))])

callback_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

schola_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

sb3_verbosity (Annotated[int, Parameter(validator=(Number(lt=None, lte=2, gt=None, gte=0, modulo=None),))])

Returns

None

---

callback_verbosity

= 0 callback_verbosity: Annotated[int, Parameter(validator=Number(lt=None, lte=2, gt=None, gte=0, modulo=None))]

Verbosity level for callbacks. This controls the level of detail in the output from any callbacks used during training.

---

enable_tensorboard

= False enable_tensorboard: bool

Whether to enable TensorBoard logging.

---

log_dir

= WindowsPath('logs') log_dir: Annotated[Path, Parameter(validator=Path(exists=False, file_okay=False, dir_okay=True, ext=()))]

Directory to save TensorBoard logs. (Will be created if it doesn’t exist when tensorboard is enabled.)

---

log_freq

= 10 log_freq: Annotated[int, Parameter(validator=Number(lt=None, lte=None, gt=None, gte=0, modulo=None))]

Frequency of logging training metrics to TensorBoard. This determines how often (in terms of training steps) the training metrics will be logged to TensorBoard. A value of 10 means that every 10 training steps, the metrics will be recorded.

---

sb3_verbosity

= 1 sb3_verbosity: Annotated[int, Parameter(validator=Number(lt=None, lte=2, gt=None, gte=0, modulo=None))]

Verbosity level for Stable Baselines3 logging. This controls the level of detail in the output from Stable Baselines3 components during training.

---

schola_verbosity

= 0 schola_verbosity: Annotated[int, Parameter(validator=Number(lt=None, lte=2, gt=None, gte=0, modulo=None))]

Verbosity level for Schola-specific logging. This controls the level of detail in the output from Schola-related components during training.

---