Hydra¶

关于 +A=B 语法¶

在文档中，有两个地方提到了 +A=B 的语法。第一次是在这里：

You can add config values via the command line. The + indicates that the field is new.

$ python my_app.py +db.driver=mysql +db.user=omry +db.password=secret
db:
  driver: mysql
  user: omry
  password: secret

files

my_app.py

from omegaconf import DictConfig, OmegaConf
import hydra

@hydra.main(version_base=None)
def my_app(cfg: DictConfig) -> None:
    print(OmegaConf.to_yaml(cfg))

if __name__ == "__main__":
    my_app()

第二次是在这里：

Select an item from a config group with +GROUP=OPTION, e.g:

$ python my_app.py +db=postgresql
db:
  driver: postgresql
  pass: drowssap
  timeout: 10
  user: postgres_user

files

Directory layout

    ├─ conf
    │  └─ db
    │      ├─ mysql.yaml
    │      └─ postgresql.yaml
    └── my_app.py

db/mysql.yaml

driver: mysql
user: omry
password: secret

db/postgresql.yaml

driver: postgresql
user: postgres_user
password: drowssap
timeout: 10

my_app.py

from omegaconf import DictConfig, OmegaConf
import hydra

@hydra.main(version_base=None)
def my_app(cfg: DictConfig) -> None:
    print(OmegaConf.to_yaml(cfg))

if __name__ == "__main__":
    my_app()

前者表示增加一个 field，后者表示指定一个 group，其含义是不同的，而看起来是有歧义的。

根据我的测试，+A=B 具体是哪一种，取决于是否存在名为 A 的 folder。即：

• 如果存在名为 A 的 folder，则 +A=B 表示指定 A group 里的 b.yaml 项；
• 如果不存在名为 A 的 folder，则 +A=B 表示增加一个 field，其 key 为 A，value 为 B；

更进一步的，只要当前目录存在名为 A 的 folder，那么在当前 yaml 文件中就无法将 A 作为一个 field 的 key。

之所以强调当前，是因为它可以被父母的 yaml 文件中的，以 A 为 key 的 k-v 对覆盖。

例如，虽然添加 A=1 替换作为 group 的 A 会报错，但是添加 A.B=1 却可以覆盖 A 下的作为 group 的 B；亦或在最的 config.yaml 里添加这样一段也可以起到同样的效果：

A:
  B: 1

即，对于“无法将 group 覆盖为 field”这件事的保护，只有目录一层内有效。

覆盖关系¶

首先，除了在上一节提到的关于 field 和 group 的覆盖关系，更重要的是在不同层的 yaml 之间，相同键的值的覆盖关系。

首先，单看 defaults，官方在文档中有提到规则：

The defaults are ordered:

• If multiple configs define the same value, the last one wins.
• If multiple configs contribute to the same dictionary, the result is the combined dictionary.

此外，如果已经在内层 defaults 设置了键的默认值，就不能在外层为这个键设置默认值，反之亦然。

defaults:
  - group1: option1
  - group1/group2: option1_1

defaults:
  - group2: option1_1

因此，一般来说尽量避免让配置层数超过两层。

而关于 defaults 以外的部分，规则如下：

1. 当最外层的 config.yaml 和在 defaults: 里指定的 yaml 配置文件存在冲突的键时，以 config.yaml 里的为准，（无论是否有 GROUP=OPTION 选项）；
2. 当键不存在于 defaults: 中，而只在命令行中通过 +GROUP=OPTION 选中时，以 OPTION.yaml 里的为准；

激励

评论