csv_logs¶
Classes
Log to local file system in yaml and CSV format. |
|
Experiment writer for CSVLogger. |
CSV logger¶
CSV logger for basic experiment logging that does not require opening ports
- class pytorch_lightning.loggers.csv_logs.CSVLogger(save_dir, name='default', version=None, prefix='', flush_logs_every_n_steps=100)[source]¶
Bases:
pytorch_lightning.loggers.base.LightningLoggerBase
Log to local file system in yaml and CSV format.
Logs are saved to
os.path.join(save_dir, name, version)
.Example
>>> from pytorch_lightning import Trainer >>> from pytorch_lightning.loggers import CSVLogger >>> logger = CSVLogger("logs", name="my_exp_name") >>> trainer = Trainer(logger=logger)
- Parameters
name¶ (
Optional
[str
]) – Experiment name. Defaults to'default'
.version¶ (
Union
[int
,str
,None
]) – Experiment version. If version is not specified the logger inspects the save directory for existing versions, then automatically assigns the next available version.prefix¶ (
str
) – A string to put at the beginning of metric keys.flush_logs_every_n_steps¶ (
int
) – How often to flush logs to disk (defaults to every 100 steps).
- log_metrics(metrics, step=None)[source]¶
Records metrics. This method logs metrics as as soon as it received them. If you want to aggregate metrics for one specific step, use the
agg_and_log_metrics()
method.
- property experiment: pytorch_lightning.loggers.csv_logs.ExperimentWriter¶
Actual ExperimentWriter object. To use ExperimentWriter features in your
LightningModule
do the following.Example:
self.logger.experiment.some_experiment_writer_function()
- property log_dir: str¶
The log directory for this run.
By default, it is named
'version_${self.version}'
but it can be overridden by passing a string value for the constructor’s version parameter instead ofNone
or an int.
- property name: str¶
Gets the name of the experiment.
- Returns
The name of the experiment.
- property root_dir: str¶
Parent directory for all checkpoint subdirectories.
If the experiment name parameter is
None
or the empty string, no experiment subdirectory is used and the checkpoint will be saved in “save_dir/version_dir”
- property save_dir: Optional[str]¶
The current directory where logs are saved.
- Returns
The path to current directory where logs are saved.
- property version: int¶
Gets the version of the experiment.
- Returns
The version of the experiment if it is specified, else the next version.