Logging

Bases: Plugin, PluginProtocol

              flowchart TD
              liblaf.cherries.plugins.logging.Logging[Logging]
              liblaf.cherries.core.plugin._plugin.Plugin[Plugin]
              liblaf.cherries.core._protocol.PluginProtocol[PluginProtocol]
              liblaf.cherries.core.assets._protocol.AssetPluginProtocol[AssetPluginProtocol]
              liblaf.cherries.core.metrics._protocol.MetricPluginProtocol[MetricPluginProtocol]
              liblaf.cherries.core.others._protocol.OtherPluginProtocol[OtherPluginProtocol]
              liblaf.cherries.core.params._protocol.ParamPluginProtocol[ParamPluginProtocol]

                              liblaf.cherries.core.plugin._plugin.Plugin --> liblaf.cherries.plugins.logging.Logging
                
                liblaf.cherries.core._protocol.PluginProtocol --> liblaf.cherries.plugins.logging.Logging
                                liblaf.cherries.core.assets._protocol.AssetPluginProtocol --> liblaf.cherries.core._protocol.PluginProtocol
                
                liblaf.cherries.core.metrics._protocol.MetricPluginProtocol --> liblaf.cherries.core._protocol.PluginProtocol
                
                liblaf.cherries.core.others._protocol.OtherPluginProtocol --> liblaf.cherries.core._protocol.PluginProtocol
                
                liblaf.cherries.core.params._protocol.ParamPluginProtocol --> liblaf.cherries.core._protocol.PluginProtocol
                



              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"
              click liblaf.cherries.core._protocol.PluginProtocol href "" "liblaf.cherries.core._protocol.PluginProtocol"
              click liblaf.cherries.core.assets._protocol.AssetPluginProtocol href "" "liblaf.cherries.core.assets._protocol.AssetPluginProtocol"
              click liblaf.cherries.core.metrics._protocol.MetricPluginProtocol href "" "liblaf.cherries.core.metrics._protocol.MetricPluginProtocol"
              click liblaf.cherries.core.others._protocol.OtherPluginProtocol href "" "liblaf.cherries.core.others._protocol.OtherPluginProtocol"
              click liblaf.cherries.core.params._protocol.ParamPluginProtocol href "" "liblaf.cherries.core.params._protocol.ParamPluginProtocol"
            

Initialize Python logging and mirror metrics to the run log.

Attributes:

Parameters:

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

log_file: Path

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

run: Run = field(repr=False)

end(exc: BaseException | None = None) -> None

22
23
24
25
26
27
28

def end(self, exc: BaseException | None = None) -> None:
    """End a run.

    Args:
        exc: Exception raised by the experiment, if any.
    """
    raise NotImplementedError

log_asset(
    path: Path,
    *,
    metadata: Mapping[str, Any] | None = None,
    report: bool = True,
) -> None

 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

def log_asset(
    self,
    path: Path,
    *,
    metadata: Mapping[str, Any] | None = None,
    report: bool = True,
) -> None:
    """Record an existing artifact path.

    Args:
        path: Existing file or directory to record.
        metadata: Optional artifact metadata, usually including `type`.
        report: Whether the path is the primary user-facing artifact.
            Companion files are logged with `report=False`.
    """
    ...

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

39
40
41
42
43

@override
@core.impl
def log_metric(self, name: str, value: float, *, step: int, time: datetime) -> None:
    """Write one metric to the Python logger."""
    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

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

log_other(name: str, value: Any) -> None

7
8
9

def log_other(self, name: str, value: Any) -> None:
    """Record one flattened metadata value."""
    ...

log_others(others: dict[str, Any]) -> None

11
12
13

def log_others(self, others: dict[str, Any]) -> None:
    """Record multiple already-flattened metadata values."""
    ...

log_param(name: str, value: Any) -> None

7
8
9

def log_param(self, name: str, value: Any) -> None:
    """Record one flattened parameter value."""
    ...

log_params(params: dict[str, Any]) -> None

11
12
13

def log_params(self, params: dict[str, Any]) -> None:
    """Record multiple already-flattened parameter values."""
    ...

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

33
34
35
36
37

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