Local

Bases: Plugin, PluginProtocol

              flowchart TD
              liblaf.cherries.plugins.local.Local[Local]
              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.local.Local
                
                liblaf.cherries.core._protocol.PluginProtocol --> liblaf.cherries.plugins.local.Local
                                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.local.Local href "" "liblaf.cherries.plugins.local.Local"
              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"
            

Copy the entrypoint, logs, and artifacts into .cherries/runs/.

Attributes:

Parameters:

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

folder: Path

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

49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

@override
@core.impl
def log_asset(
    self,
    path: Path,
    *,
    metadata: Mapping[str, Any] | None = None,
    report: bool = True,
) -> None:
    """Copy `path` under the snapshot's `assets/` directory."""
    if path.is_relative_to(self.run.working_dir):
        target: Path = self.folder / path.relative_to(self.run.working_dir)
    else:
        target: Path = self.folder / "assets" / path.name
    self._copy(path, target)

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

12
13
14
15
16

def log_metric(
    self, name: str, value: float, *, step: int, time: datetime.datetime
) -> None:
    """Record one metric sample."""
    ...

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

18
19
20
21
22

def log_metrics(
    self, metrics: dict[str, float], *, step: int, time: datetime.datetime
) -> None:
    """Record a batch of already-flattened metric samples."""
    ...

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() -> None

42
43
44
45
46
47

@override
@core.impl
def start(self) -> None:
    """Configure local logging and copy the entrypoint."""
    self._config_logging()
    self._copy(self.run.entrypoint, self.folder / "src" / self.run.entrypoint.name)