一个用于优雅配置复杂应用的框架。

访问官网获取更多信息，
或点击下方缩略图观看关于Hydra的一分钟介绍视频。

---

发布版本

稳定版

Hydra 1.3 是 Hydra 的稳定版本。

• 文档
• 安装命令：pip install hydra-core --upgrade

有关 Hydra 最近变更的摘要，请参阅 NEWS.md 文件。

许可证

Hydra 采用 MIT 许可证 许可。

Hydra 生态系统

以下是一些基于 Hydra 功能构建的第三方库：

• hydra-zen：用于与 Hydra 配合使用的 Python 式工具。提供动态配置生成能力、增强的配置存储功能、用于启动 Hydra 作业的 Python API 等。
• lightning-hydra-template：一款用户友好的模板，将 Hydra 与 Pytorch-Lightning 结合，适用于机器学习实验。
• hydra-torch：由 configen 生成的配置类，为 Hydra 应用程序提供类型安全的 PyTorch 配置。
• NVIDIA 的 DeepLearningExamples 仓库包含一个 Hydra 启动器插件，即 distributed_launcher，它利用了 PyTorch 的 distributed.launch API。

如有任何问题，欢迎在 Github 讨论区或 StackOverflow 上提问（使用标签 #fb-hydra 或 #omegaconf）：

• Github 讨论区
• StackOverflow
• Twitter

请查看 Meta AI 的博客文章，了解 Hydra 如何融入 Meta 为实现深度学习平台互操作性而进行的重构工作中。

引用 Hydra

如果您在研究中使用 Hydra，请使用以下 BibTeX 条目：

@Misc{Yadan2019Hydra,
  author =       {Omry Yadan},
  title =        {Hydra - 一个用于优雅配置复杂应用的框架},
  howpublished = {Github},
  year =         {2019},
  url =          {https://github.com/facebookresearch/hydra}
}

Hydra 快速上手指南

Hydra 是一个用于优雅地配置复杂应用程序的框架，特别适合机器学习和深度学习实验。它基于 OmegaConf，支持层级配置、动态组合和命令行覆盖。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：3.8 - 3.12
• 前置依赖：无特殊系统级依赖，需确保已安装 pip 和 python

安装步骤

推荐使用国内镜像源加速安装（如清华大学开源软件镜像站）：

pip install hydra-core --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

若需使用最新开发版（不推荐生产环境）：

pip install --pre hydra-core -i https://pypi.tuna.tsinghua.edu.cn/simple

验证安装：

python -c "import hydra; print(hydra.__version__)"

基本使用

1. 创建配置文件

在项目根目录创建 config.yaml：

db:
  driver: mysql
  user: omry
  pass: secret

2. 编写 Python 应用

创建 my_app.py：

import hydra
from omegaconf import DictConfig

@hydra.main(version_base=None, config_path=".", config_name="config")
def my_app(cfg: DictConfig) -> None:
    print(f"Database driver: {cfg.db.driver}")
    print(f"User: {cfg.db.user}")

if __name__ == "__main__":
    my_app()

3. 运行应用

默认运行：

python my_app.py

通过命令行覆盖配置：

python my_app.py db.driver=postgresql db.user=admin

查看生成的配置日志目录（Hydra 自动创建）：

ls outputs/

---

现在你已成功使用 Hydra 管理应用配置。更多高级功能（如多配置组合、插件系统）请参考官方文档：https://hydra.cc