Git

Bases: Plugin, PluginProtocol

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

Record Git metadata and optionally commit dirty experiment outputs.

Attributes:

Parameters:

• name (PluginName, default: <dynamic> ) –
• run (Run) –
• commit (bool, default: False ) –
• verify (bool, default: False ) –

commit: bool = field(default=False, kw_only=True)

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

repo: Repo | None

run: Run = field(repr=False)

verify: bool = field(default=False, kw_only=True)

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

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

@override
@core.impl(before=("Comet",))
def end(self, exc: BaseException | None = None) -> None:
    """Commit dirty changes if configured and log the final Git SHA."""
    if self.repo is None:
        return
    if self.commit and self.repo.is_dirty(untracked_files=True):
        message: str = self._make_commit_message()
        try:
            self.repo.git.add(all=True)
            subprocess.run(["git", "status"], check=False)
            self.repo.git.commit(message=message, no_verify=not self.verify)
        except git.GitCommandError:
            logger.exception("")
    self.run.log_other("cherries/git/sha", self.repo.head.commit.hexsha)

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

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

18
19
20

def start(self) -> None:
    """Start a run."""
    raise NotImplementedError