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

2024-04-22 21:04

本文主要是介绍【看不懂命令行、.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。
在这里插入图片描述
命令行 bashpython 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.methodprint('flag:',flag)print('all config:',cfg)

得到的结果如下

flag: clipfontall 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/

这篇关于【看不懂命令行、.yaml?】Hydra 库极速入门的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/926853

相关文章

SQLite3命令行工具最佳实践指南

《SQLite3命令行工具最佳实践指南》SQLite3是轻量级嵌入式数据库,无需服务器支持,具备ACID事务与跨平台特性,适用于小型项目和学习,sqlite3.exe作为命令行工具,支持SQL执行、数... 目录1. SQLite3简介和特点2. sqlite3.exe使用概述2.1 sqlite3.exe

Python中OpenCV与Matplotlib的图像操作入门指南

《Python中OpenCV与Matplotlib的图像操作入门指南》:本文主要介绍Python中OpenCV与Matplotlib的图像操作指南,本文通过实例代码给大家介绍的非常详细,对大家的学... 目录一、环境准备二、图像的基本操作1. 图像读取、显示与保存 使用OpenCV操作2. 像素级操作3.

Python的pip在命令行无法使用问题的解决方法

《Python的pip在命令行无法使用问题的解决方法》PIP是通用的Python包管理工具,提供了对Python包的查找、下载、安装、卸载、更新等功能,安装诸如Pygame、Pymysql等Pyt... 目录前言一. pip是什么?二. 为什么无法使用?1. 当我们在命令行输入指令并回车时,一般主要是出现以

POI从入门到实战轻松完成EasyExcel使用及Excel导入导出功能

《POI从入门到实战轻松完成EasyExcel使用及Excel导入导出功能》ApachePOI是一个流行的Java库,用于处理MicrosoftOffice格式文件,提供丰富API来创建、读取和修改O... 目录前言:Apache POIEasyPoiEasyExcel一、EasyExcel1.1、核心特性

Python中模块graphviz使用入门

《Python中模块graphviz使用入门》graphviz是一个用于创建和操作图形的Python库,本文主要介绍了Python中模块graphviz使用入门,具有一定的参考价值,感兴趣的可以了解一... 目录1.安装2. 基本用法2.1 输出图像格式2.2 图像style设置2.3 属性2.4 子图和聚

windows和Linux使用命令行计算文件的MD5值

《windows和Linux使用命令行计算文件的MD5值》在Windows和Linux系统中,您可以使用命令行(终端或命令提示符)来计算文件的MD5值,文章介绍了在Windows和Linux/macO... 目录在Windows上:在linux或MACOS上:总结在Windows上:可以使用certuti

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

SpringShell命令行之交互式Shell应用开发方式

《SpringShell命令行之交互式Shell应用开发方式》本文将深入探讨SpringShell的核心特性、实现方式及应用场景,帮助开发者掌握这一强大工具,具有很好的参考价值,希望对大家有所帮助,如... 目录引言一、Spring Shell概述二、创建命令类三、命令参数处理四、命令分组与帮助系统五、自定

Spring Shell 命令行实现交互式Shell应用开发

《SpringShell命令行实现交互式Shell应用开发》本文主要介绍了SpringShell命令行实现交互式Shell应用开发,能够帮助开发者快速构建功能丰富的命令行应用程序,具有一定的参考价... 目录引言一、Spring Shell概述二、创建命令类三、命令参数处理四、命令分组与帮助系统五、自定义S

使用Python将JSON,XML和YAML数据写入Excel文件

《使用Python将JSON,XML和YAML数据写入Excel文件》JSON、XML和YAML作为主流结构化数据格式,因其层次化表达能力和跨平台兼容性,已成为系统间数据交换的通用载体,本文将介绍如何... 目录如何使用python写入数据到Excel工作表用Python导入jsON数据到Excel工作表用