Logging

Bases: Plugin

              flowchart TD
              liblaf.cherries.plugins.logging.Logging[Logging]
              liblaf.cherries.core.plugin._plugin.Plugin[Plugin]

                              liblaf.cherries.core.plugin._plugin.Plugin --> liblaf.cherries.plugins.logging.Logging
                


              click liblaf.cherries.plugins.logging.Logging href "" "liblaf.cherries.plugins.logging.Logging"
              click liblaf.cherries.core.plugin._plugin.Plugin href "" "liblaf.cherries.core.plugin._plugin.Plugin"
            

Initialize Python logging and mirror metrics to the run log.

Attributes:

Parameters:

• name (PluginName, default: <dynamic> ) –
• run (Run) –

Methods:

• log_metric –

  Write one metric to the Python logger.

• log_metrics –

  Write multiple metrics to the Python logger.

• start –

  Initialize liblaf.logging for the run log file.

log_file: Path

name: PluginName = attrs.field(
    default=attrs.Factory(_default_name, takes_self=True),
    kw_only=True,
)

run: Run = attrs.field(repr=False)

log_metric(
    name: str, value: float, *, step: int, time: datetime
) -> None

39
40
41
42
43

@core.impl
def log_metric(self, name: str, value: float, *, step: int, time: datetime) -> None:
    """Write one metric to the Python logger."""
    del time
    logger.info("step: %s, %s: %s", step, name, value)

log_metrics(
    metrics: Mapping[str, float],
    *,
    step: int,
    time: datetime,
) -> None

45
46
47
48
49
50
51

@core.impl
def log_metrics(
    self, metrics: Mapping[str, float], *, step: int, time: datetime
) -> None:
    """Write multiple metrics to the Python logger."""
    del time
    logger.info("step: %s, %s", step, metrics)

start(*args, **kwargs) -> None

33
34
35
36
37

@core.impl(before=("Local",))
def start(self, *args, **kwargs) -> None:
    """Initialize `liblaf.logging` for the run log file."""
    del args, kwargs
    liblaf.logging.init(file=self.log_file, force=True)