Skip to content

Commit d2b91dc

Browse files
authored
Add missing arg description
Added sub_dir parameter to specify log sub-directory.
1 parent d494e3b commit d2b91dc

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/lightning/pytorch/loggers/csv_logs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ class CSVLogger(Logger, FabricCSVLogger):
8080
directory for existing versions, then automatically assigns the next available version.
8181
prefix: A string to put at the beginning of metric keys.
8282
flush_logs_every_n_steps: How often to flush logs to disk (defaults to every 100 steps).
83-
83+
sub_dir: Sub-directory to group CSV logs. If a ``sub_dir`` argument is passed
84+
then logs are saved in ``/root_dir/name/version/sub_dir/``. Defaults to ``None`` in which case
85+
logs are saved in ``/root_dir/name/version/``.
8486
"""
8587

8688
LOGGER_JOIN_CHAR = "-"

0 commit comments

Comments
 (0)