【看不懂命令行、.yaml？】Hydra 库极速入门

Hydra 是一个开源的 Python 框架，可以简化研究和其他复杂应用程序的开发。其核心功能是通过组合动态创建层次化的配置，并可以通过配置文件和命令行进行覆盖。Hydra 的名字来源于它能够运行多个类似的作业 - 就像一个多头的水怪一样。

主要特性:

1. 从多个不同来源的可组合层次化配置
2. 可以通过命令行指定或覆盖配置
3. 动态命令行 tab 补全
4. 在本地运行应用程序或启动它进行远程运行
5. 使用单个命令运行具有不同参数的多个 jobs

以开源项目 https://github.com/ximinng/PyTorch-SVGRender 为例，在 svg_render.py 中的以下这段代码是 hydra 库的具体应用

@hydra.main(version_base=None, config_path="conf", config_name='config')
def main(cfg: omegaconf.DictConfig):
    """
    The project configuration is stored in './conf/config.yaml’
    And method configurations are stored in './conf/x/’
    """

    # print(omegaconf.OmegaConf.to_yaml(cfg))
    flag = cfg.x.method

Hydra 提供了装饰器 @hydra.main 来修饰 main 函数，其具体含义如下：

1. @hydra.main：这是一个 Hydra 提供的装饰器，用于标识一个函数是 Hydra 应用程序的主函数。通过使用这个装饰器，Hydra 可以识别并执行标记的函数作为程序的入口点。
2. (version_base=None, config_path=“conf”, config_name=‘config’)：这是 @hydra.main 装饰器的参数列表，用于配置 Hydra 应用程序的行为。
3. version_base=None：这个参数用于指定 Hydra 应用程序的版本基础路径。如果设置为 None，则表示不使用版本控制。如果设置了一个路径，则 Hydra 将根据该路径来管理应用程序的版本。
4. config_path=“conf”：这个参数用于指定 Hydra 应用程序配置文件的搜索路径。在这个例子中，配置文件会在 conf 目录下进行搜索。
5. config_name=‘config’：这个参数用于指定 Hydra 应用程序配置文件的名称。在这个例子中，配置文件的名称为 config.yaml。

cfg.x.method 即对应各个 .yaml 中的 method。

当命令行 bash 为 python svg_render.py x=clipfont prompt='Starry Night by Vincent van gogh' target='./data/alphabet1.svg'

@hydra.main(version_base=None, config_path="conf", config_name='config')
def main(cfg: omegaconf.DictConfig):
    """
    The project configuration is stored in './conf/config.yaml’
    And method configurations are stored in './conf/x/’
    """

    # print(omegaconf.OmegaConf.to_yaml(cfg))
    flag = cfg.x.method
    print('flag:',flag)
    print('all config:',cfg)

得到的结果如下

flag: clipfont

all config: {'target': './data/alphabet1.svg', 'prompt': 'Starry Night by Vincent van gogh', 'neg_prompt': None, 'state': {'cpu': False, 'mprec': 'no'}, 'diffuser': {'download': False, 'force_download': False, 'resume_download': False}, 'diffvg': {'print_timing': False}, 'seed': 951222, 'multirun': False, 'srange': None, 'result_path': './workspace', 'save_step': 10, 'eval_step': 10, 'mv': False, 'framefreq': 5, 'framerate': 24, 'x': {'method': 'clipfont', 'lr_base': {'point': 0.1, 'color': 0.01}, 'lr_decay_rate': 0.1, 'decay_steps': [1000, 1500], 'lr_schedule': False, 'num_iter': 200, 'batch_size': 1, 'font': {'reinit': False, 'reinit_color': 'randn'}, 'clip': {'model_name': 'ViT-B/32'}, 'thresh': 0.0, 'num_crops': 128, 'crop_size': 230, 'lam_patch': 150, 'lam_dir': 30, 'lam_lpips': 0, 'lam_l2': 0}}

看出 all config 里其实就是命令行 bash加 config.yaml 加 clipfont.yaml 这三者的组合，非常具有层次性，使得代码的复用性很高、且结构清晰。

以上就是 Hydra 的大概用处，想要了解更多，可查阅下方参考资料：
[1] Hydra 官方文档：https://hydra.cc/docs/intro/
[2] Hydra GitHub 仓库：https://github.com/facebookresearch/hydra
[3] https://blog.csdn.net/a486259/article/details/125897007
[4] https://www.kingname.info/2022/04/22/hydra/