从 Python 子/子子目录模块引用 Hydra\ 的 `conf` 目录

Answer 1

首先我会介绍一些可能的解决方案，然后我会给出解释。 以下是您可以做的三件事来使您的示例工作：

修复1：创建conf/__init__.py并将config_path="conf"更改为config_path="../conf"：

├── conf
│   ├── config.yaml
│   └── __init__.py
├── modules
│   └── module.py
└── my_app.py

# modules/module.py
import hydra
from omegaconf import DictConfig, OmegaConf

@hydra.main(config_path="../conf", config_name="config")  # relative path
def module_function(cfg: DictConfig):
    print(OmegaConf.to_yaml(cfg))

修复 2：将 conf 移动到 modules/conf 并创建 modules/conf/__init__.py：

├── modules
│   ├── conf
│   │   ├── config.yaml
│   │   └── __init__.py
│   └── module.py
└── my_app.py

修复 3：在模块中定义您的装饰函数，该函数将被称为 __main__：

├── conf
│   └── config.yaml
└── my_app.py

# my_app.py
import hydra
from omegaconf import DictConfig, OmegaConf

@hydra.main(config_path="conf", config_name="config")
def module_function(cfg: DictConfig):
    print(OmegaConf.to_yaml(cfg))

if __name__ == "__main__":
    module_function()

修复 3 不会让 OP 非常满意 :)

解释

在您的示例中，由于您已导入修饰函数（而不是在 __main__ 模块中定义它），Hydra 将参数 config_path="conf" 解释为相对于定义修饰函数的模块的父级。在您的示例中，装饰函数在modules.module 中定义，其父级为modules，因此Hydra 正在寻找一个名为modules.conf 的python 包。如果找到，将在此包中搜索 yaml 文件。

上面的修复 2 采用确保 modules/conf/__init__.py 存在的方法，因此 modules.conf 实际上是一个 python 包。 同时，Fix 1 采用了使用相对路径config_path="../conf" 的方法。 Hydra 然后查找名为conf 的顶级包。由于存在conf/__init__.py，因此会找到此顶级conf 包并搜索yaml 文件。为了发现这个包，Hydra 使用了 python 导入机制。这意味着 Hydra 能够发现位于您的$PYTHONPATH 上其他位置或通过包管理器（例如pip）安装的 python 包中的 yaml 文件。

在修复 3 的情况下，我们有 module_function.__module__ == "__main__"，这意味着 Hydra 不能依赖 python 的导入机制来发现 module_function 的定义位置。作为后备，九头蛇试图找到一个目录conf（而不是包裹conf);这就是修复 3 不需要 __init__.py 文件的原因。Here 是实现此行为的关键代码行。请注意，conf 仍被视为相对路径，相对于包含文件定义了修饰函数（而不是定义了模块定义它）。 Here 是实现此相对路径计算的函数（对于模块情况和目录情况）。