DiskLogger

class torchtune.training.metric_logging.DiskLogger(log_dir: str, filename: Optional[str] = None, **kwargs)

Logger to disk.

Parameters:

• log_dir (str) – directory to store logs

• filename (Optional[str]) – optional filename to write logs to. Default: None, in which case log_{unixtimestamp}.txt will be used.

• **kwargs – additional arguments

Warning

This logger is not thread-safe.

Note

This logger creates a new file based on the current time.

close() → None

Close log resource, flushing if necessary. Logs should not be written after close is called.

log(name: str, data: Union[Tensor, ndarray, int, float], step: int) → None

Log scalar data.

Parameters:

• name (str) – tag name used to group scalars

• data (Scalar) – scalar data to log

• step (int) – step value to record

log_config(config: DictConfig) → None

Logs the config as file

Parameters:

config (DictConfig) – config to log

log_dict(payload: Mapping[str, Union[Tensor, ndarray, int, float]], step: int) → None

Log multiple scalar values.

Parameters:

• payload (Mapping[str, Scalar]) – dictionary of tag name and scalar value

• step (int) – step value to record