Hydra 配置管理使用教程

在 Jupyter Notebook 中使用 Hydra 的 `compose()` 时，默认不加载 Hydra 运行时配置（如 `hydra.run.dir`），需显式启用 `return_hydra_config=True` 才能访问 `hydra` 命名空间，并注意替换配置内 `${hydra:xxx}` 语法为兼容形式。

Hydra 的 @hydra.main() 装饰器在脚本中会自动初始化 Hydra 核心组件（包括 HydraConfig），从而支持 ${hydra.xxx} 占位符解析和工作目录动态生成。但在 Jupyter Notebook 中，由于缺少完整的启动上下文（无 sys.argv、无 HydraConfig 初始化），直接调用 compose() 默认不会注入 hydra 配置节点，因此访问 cfg.hydra.run.dir 会抛出 ConfigAttributeError。

✅ 正确做法是：在调用 compose() 时传入 return_hydra_config=True 参数：

from hydra import compose, initialize

initialize(version_base=None, config_path="config")
cfg = compose(config_name="config.yaml", return_hydra_config=True)  # ← 关键！
print(cfg.hydra.run.dir)  # ✅ 现在可正常访问

⚠️ 注意事项：

• return_hydra_config=True 会将 Hydra 运行时配置（如 hydra.job.name, hydra.run.dir, hydra.runtime.cwd）作为顶层字段注入到返回的 cfg 中，结构等价于 @hydra.main() 启动后 OmegaConf 的完整视图。
• 配置文件中禁止使用 : 分隔的插值语法（如 ${hydra:job.name} 或 ${hydra.run.dir}） —— compose() API 不支持该语法，它依赖 HydraConfig 的运行时注册，而该注册仅在 @hydra.main() 内部触发。若配置中存在此类写法，会报错或解析失败。

? 替代方案（推荐用于 Notebook）：

1. 移除配置中的 ${hydra:xxx} 插值，改用纯静态路径或 Python 层动态构造：

   # ❌ 错误（Notebook 中不支持）
   hydra:
     run:
       dir: outputs/${hydra:job.name}

   # ✅ 正确（静态 + 后续 Python 拼接）
   hydra:
     run:
       dir: outputs/  # 纯路径前缀

   然后在 Notebook 中手动补全：

   import os
   from datetime import datetime
   
   base_dir = cfg.hydra.run.dir
   timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
   nx, ny = cfg.train_nn.nx, cfg.train_nn.ny
   b, rho = cfg.train_nn.b, cfg.train_nn.rho
   dynamic_subdir = f"nx{nx}-ny{ny}-b{b}-rho{rho}-{timestamp}"
   full_output_dir = os.path.join(base_dir, dynamic_subdir)
   os.makedirs(full_output_dir, exist_ok=True)
   print("Output dir:", full_output_dir)

2. 若必须复用原有插值逻辑，可借助 hydra.utils.get_original_cwd() 和 hydra.utils.to_absolute_path() 辅助定位资源，但路径生成仍建议在 Python 层完成，确保可控性与可调试性。

? 总结：Jupyter 中使用 Hydra 的核心原则是——*compose() 是轻量配置加载器，非完整 Hydra 运行时；要获得 `hydra.配置，请务必启用return_hydra_config=True，并主动规避配置文件内的:` 插值语法，将动态逻辑上移到 Notebook 代码中实现。**