Hydra 配置文档

Documentation of Hydra Config

Hydra provides a way to dynamically create a hierarchical configuration by composition and override it through config files and the command line, leveraging OmegaConf。我正在寻找一种推荐的方法来记录参数,但我找不到(有记录的)方法。什么是最佳实践?来自 argparse,我喜欢记录参数内联的方式,即接近代码。

问得好!答案是:parameter-by-parameter 文档尚未实现(截至 Hydra v1.1、OmegaConf v2.1)。

未来的计划是:

  • 在 OmegaConf 中,公开一个 API 允许用户将文档(和其他元数据)附加到结构化配置的每个字段。参见 this open OmegaConf issue
  • 完成上述操作后,实施 Hydra 功能,允许根据参数的元数据打印 parameter-specific 帮助消息。参见 this open Hydra issue

目前,我们能做的最好的事情就是 customize 一般应用程序帮助消息(即 --help 命令行标志)。