Language

unilab.logging.common¶

Classes

BaseTrainingLogger

Shared lifecycle and backend logging setup for rich training loggers.

class unilab.logging.common.BaseTrainingLogger[source]¶

Bases: object

Shared lifecycle and backend logging setup for rich training loggers.

Parameters:

algo_name (str)
max_iterations (int)
num_envs (int)
env_name (str)
log_dir (str)
log_backend (str)
wandb_project (str)
wandb_entity (str | None)
wandb_name (str)
wandb_group (list[str] | None | str)
wandb_job_type (str | None)
wandb_tags (list[str] | None)
wandb_notes (str | None)
refresh_per_second (int)
tensorboard_subdir (str | None)
wandb_config (dict[str, Any] | None)

__init__(*, algo_name, max_iterations, num_envs, env_name, log_dir, log_backend, wandb_project, wandb_entity, wandb_name, wandb_group, wandb_job_type, wandb_tags, wandb_notes, refresh_per_second=4, tensorboard_subdir='tb', wandb_config=None)[source]¶

Parameters:

algo_name (str)
max_iterations (int)
num_envs (int)
env_name (str)
log_dir (str)
log_backend (str)
wandb_project (str)
wandb_entity (str | None)
wandb_name (str)
wandb_group (list[str] | None | str)
wandb_job_type (str | None)
wandb_tags (list[str] | None)
wandb_notes (str | None)
refresh_per_second (int)
tensorboard_subdir (str | None)
wandb_config (dict[str, Any] | None)

start(*, status='')[source]¶

Parameters:: status (str)

close()[source]¶

Release live terminal state and backend handles without printing a summary.

Return type:: None

finish(*, title='Training Summary', extra_summary='')[source]¶

Parameters:

title (str)
extra_summary (str)

update_ep_length(length)[source]¶

Parameters:: length (float)

log_save(path)[source]¶

Parameters:: path (str)