借助Hydra/DVC管理配置，如何默认记录Git Hash至Hydra日志？

你可以通过Hydra的自定义日志配置或全局钩子机制，实现自动在日志中记录Git Hash，无需在每个实验脚本中重复编写代码。以下是具体可行的方法：

方法1：自定义日志格式注入Git Hash #

利用Hydra的日志扩展能力，在全局日志模板中加入Git Hash字段：

1. 先写一个获取Git Hash的工具函数：

# utils/git_utils.py
import subprocess
from typing import Optional

def get_git_hash() -> Optional[str]:
    try:
        # 获取短Hash，也可以用--long获取完整Hash
        result = subprocess.run(
            ["git", "rev-parse", "--short", "HEAD"],
            capture_output=True,
            text=True,
            check=True
        )
        return result.stdout.strip()
    except (subprocess.CalledProcessError, FileNotFoundError):
        # 非Git环境或未安装Git时返回占位符
        return "unknown"

2. 实现日志过滤器，把Git Hash注入日志记录：

# utils/git_utils.py
import logging

class GitHashFilter(logging.Filter):
    def __init__(self, name: str = ""):
        super().__init__(name)
        self.git_hash = get_git_hash()

    def filter(self, record: logging.LogRecord) -> bool:
        record.git_hash = self.git_hash
        return True

3. 在Hydra配置目录（如conf/hydra/）下创建日志配置文件logging.yaml：

version: 1
formatters:
  default:
    # 自定义日志格式，加入git_hash字段
    format: "[%(asctime)s][%(levelname)s][git:%(git_hash)s] %(message)s"
filters:
  git_hash:
    # 指定我们写的过滤器类路径
    type: "utils.git_utils.GitHashFilter"
handlers:
  console:
    class: logging.StreamHandler
    formatter: default
    filters: [git_hash]
root:
  level: INFO
  handlers: [console]

4. 在主配置文件中指定使用这个日志配置：

# conf/config.yaml
hydra:
  logging:
    config: hydra/logging.yaml

这样每次启动实验，控制台日志会自动带上当前Git短Hash，完全无需修改实验代码。

方法2：用Hydra全局钩子自动记录 #

通过Hydra的pre_run钩子，在实验启动时自动打印Git Hash，甚至可以把Hash存入配置：

1. 在主配置中启用钩子：

# conf/config.yaml
hydra:
  hooks:
    - hook: hooks.git_hash_hook.GitHashHook

2. 编写钩子类：

# hooks/git_hash_hook.py
import logging
from hydra.core.hook import Hook
from omegaconf import DictConfig
from utils.git_utils import get_git_hash

class GitHashHook(Hook):
    def pre_run(self, config: DictConfig, **kwargs) -> None:
        git_hash = get_git_hash()
        # 直接在日志中打印Git Hash
        logging.info(f"当前实验关联Git提交Hash: {git_hash}")
        # 可选：把Hash注入配置，方便后续和DVC版本关联保存
        config.git_hash = git_hash

这种方式更灵活，除了日志记录，还能把Git Hash和实验配置绑定，后续可以和DVC管理的配置版本一起归档，完美关联代码版本和配置版本。

注意事项 #

• 确保运行环境安装了Git，且代码处于Git仓库目录下，否则会显示unknown。
• 如果需要记录完整Hash，把git rev-parse的参数从--short改成HEAD即可。
• 可以将Git Hash的相关代码打包成Hydra配置组，在不同实验环境中快速复用。

内容的提问来源于stack exchange，提问作者이준혁