我们❤️来自开源社区的贡献!欢迎所有人参与,所有类型的贡献——不仅仅是代码——都受到重视和赞赏。回答问题、帮助他人、主动交流以及改进文档对社区都极具价值,所以如果您愿意参与,请不要犹豫!
我们鼓励每个人先在公开Discord频道里打招呼👋。在那里我们讨论扩散模型的最新趋势、提出问题、展示个人项目、互相协助贡献,或者只是闲聊☕。
无论您选择以何种方式贡献,我们都致力于成为一个开放、友好、善良的社区。请阅读我们的行为准则,并在互动时注意遵守。我们也建议您了解指导本项目的伦理准则,并请您遵循同样的透明度和责任原则。
我们高度重视社区的反馈,所以如果您认为自己有能帮助改进库的有价值反馈,请不要犹豫说出来——每条消息、评论、issue和拉取请求(PR)都会被阅读和考虑。
您可以通过多种方式做出贡献,从在issue和讨论区回答问题,到向核心库添加新的diffusion模型。
下面我们按难度升序列出不同的贡献方式,所有方式对社区都很有价值:
重申:所有贡献对社区都具有重要价值。下文将详细说明各类贡献方式。
对于4-9类贡献,您需要提交PR(拉取请求),具体操作详见如何提交PR章节。
任何与Diffusers库相关的问题或讨论都可以发布在官方论坛或Discord频道,包括但不限于:
论坛/Discord上的每个问题都能促使社区公开分享知识,很可能帮助未来遇到相同问题的初学者。请务必提出您的疑问。 同样地,通过回答问题您也在为社区创造公共知识文档,这种贡献极具价值。
请注意:提问/回答时投入的精力越多,产生的公共知识质量就越高。精心构建的问题与专业解答能形成高质量知识库,而表述不清的问题则可能降低讨论价值。
低质量的问题或回答会降低公共知识库的整体质量。
简而言之,高质量的问题或回答应具备精确性、简洁性、相关性、易于理解、可访问性和格式规范/表述清晰等特质。更多详情请参阅如何提交优质议题章节。
关于渠道的说明:
论坛的内容能被谷歌等搜索引擎更好地收录,且帖子按热度而非时间排序,便于查找历史问答。此外,论坛内容更容易被直接链接引用。
而Discord采用即时聊天模式,适合快速交流。虽然在Discord上可能更快获得解答,但信息会随时间淹没,且难以回溯历史讨论。因此我们强烈建议在论坛发布优质问答,以构建可持续的社区知识库。若Discord讨论产生有价值结论,建议将成果整理发布至论坛以惠及更多读者。
🧨 Diffusers库的稳健性离不开用户的问题反馈,感谢您的报错。
请注意:GitHub议题仅限处理与Diffusers库代码直接相关的技术问题、错误报告、功能请求或库设计反馈。
简言之,与Diffusers库代码(含文档)无关的内容应发布至论坛或Discord。
提交新议题时请遵循以下准则:
python -c "import diffusers; print(diffusers.__version__)"显示的版本号不低于最新版本新issue通常包含以下内容:
错误报告应始终包含可复现的代码片段,并尽可能简洁明了。具体而言:
diffusers-cli env命令,然后将显示的信息复制到issue中更多信息请参阅如何撰写优质issue章节。
提交错误报告请点击此处。
优质的功能请求应包含以下要素:
提交功能请求请点击此处。
关于库设计的反馈(无论正面还是负面)能极大帮助核心维护者打造更友好的库。要了解当前设计理念,请参阅此文档如果您认为某个设计选择与当前理念不符,请说明原因及改进建议。如果某个设计选择因过度遵循理念而限制了使用场景,也请解释原因并提出调整方案。
若某个设计对您特别实用,请同样留下备注——这对未来的设计决策极具参考价值。
您可通过此链接提交设计反馈。
技术问题主要涉及库代码的实现逻辑或特定功能模块的作用。提问时请务必:
技术问题提交入口:点击此处
若diffusion模型社区发布了您希望集成到Diffusers库的新模型、pipeline或调度器,请提供以下信息:
若您愿意参与开发,请告知我们以便指导。另请尝试通过GitHub账号标记原始组件作者。
提案提交地址:新建请求
回答GitHub问题可能需要Diffusers的技术知识,但我们鼓励所有人尝试参与——即使您对答案不完全正确。高质量回答的建议:
许多问题可能存在离题、重复或无关情况。您可以通过以下方式协助维护者:
在确认提交的Bug报告正确且需要修改源代码后,请继续阅读以下章节内容。
以下所有贡献都需要提交PR(拉取请求)。具体操作步骤详见如何提交PR章节。
标有Good first issue标签的问题通常已说明解决方案建议,便于修复。若该问题尚未关闭且您想尝试解决,只需留言”我想尝试解决这个问题”。通常有三种情况:
优秀库必然拥有优秀文档!官方文档是新用户的首要接触点,因此文档贡献具有极高价值。贡献形式包括:
官方文档页面所有内容均属可修改范围,对应文档源文件可进行编辑。修改前请查阅验证说明。
阅读社区流程指南了解GitHub与Hugging Face Hub社区流程的区别。若想了解我们设立社区流程的原因,请查看GitHub Issue #841(简而言之,我们无法维护diffusion模型所有可能的推理使用方式,但也不希望限制社区构建这些流程)。
贡献社区流程是向社区分享创意与成果的绝佳方式。您可以在DiffusionPipeline基础上构建流程,任何人都能通过设置custom_pipeline参数加载使用。本节将指导您创建一个简单的”单步”流程——UNet仅执行单次前向传播并调用调度器一次。
为社区流程创建one_step_unet.py文件。只要用户已安装相关包,该文件可包含任意所需包。确保仅有一个继承自DiffusionPipeline的流程类,用于从Hub加载模型权重和调度器配置。在__init__函数中添加UNet和调度器。
同时添加register_modules函数,确保您的流程及其组件可通过save_pretrained()保存。
from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()
self.register_modules(unet=unet, scheduler=scheduler)__call__),可添加任意功能。对于”单步”流程,创建随机图像并通过设置timestep=1调用UNet和调度器一次。 from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()
self.register_modules(unet=unet, scheduler=scheduler)
def __call__(self):
image = torch.randn(
(1, self.unet.config.in_channels, self.unet.config.sample_size, self.unet.config.sample_size),
)
timestep = 1
model_output = self.unet(image, timestep).sample
scheduler_output = self.scheduler.step(model_output, timestep, image).prev_sample
return scheduler_output现在您可以通过传入UNet和调度器来运行流程,若流程结构相同也可加载预训练权重。
from diffusers import DDPMScheduler, UNet2DModel
scheduler = DDPMScheduler()
unet = UNet2DModel()
pipeline = UnetSchedulerOneForwardPipeline(unet=unet, scheduler=scheduler)
output = pipeline()
# 加载预训练权重
pipeline = UnetSchedulerOneForwardPipeline.from_pretrained("google/ddpm-cifar10-32", use_safetensors=True)
output = pipeline()您可以选择将pipeline作为GitHub社区pipeline或Hub社区pipeline进行分享。
通过向Diffusers代码库提交拉取请求来分享GitHub pipeline,将one_step_unet.py文件添加到examples/community子文件夹中。
Diffusers训练示例是位于examples目录下的训练脚本集合。
我们支持两种类型的训练示例:
研究型训练示例位于examples/research_projects,而官方训练示例包含examples目录下除research_projects和community外的所有文件夹。
官方训练示例由Diffusers核心维护者维护,研究型训练示例则由社区维护。
这与6. 贡献社区pipeline中关于官方pipeline与社区pipeline的原因相同:核心维护者不可能维护diffusion模型的所有可能训练方法。
如果Diffusers核心维护者和社区认为某种训练范式过于实验性或不够普及,相应训练代码应放入research_projects文件夹并由作者维护。
官方训练和研究型示例都包含一个目录,其中含有一个或多个训练脚本、requirements.txt文件和README.md文件。用户使用时需要先克隆代码库:
git clone https://github.com/huggingface/diffusers并安装训练所需的所有额外依赖:
cd diffusers
pip install -r examples/<your-example-folder>/requirements.txt因此添加示例时,requirements.txt文件应定义训练示例所需的所有pip依赖项,安装完成后用户即可运行示例训练脚本。可参考DreamBooth的requirements.txt文件。
python <your-example>.py --args直接运行示例提交示例时,强烈建议参考现有示例(如dreambooth)来了解规范格式。
我们强烈建议贡献者使用Accelerate库,因其与Diffusers深度集成。
当示例脚本完成后,请确保添加详细的README.md说明使用方法,包括:
贡献官方训练示例时,还需在对应目录添加测试文件(如examples/dreambooth/test_dreambooth.py),非官方示例无需此步骤。
标有Good second issue标签的问题通常比Good first issues更复杂。
这类问题的描述通常不会提供详细解决指引,需要贡献者对库有较深理解。
若您想解决此类问题,可直接提交PR并关联对应issue。若已有未合并的PR,请分析原因后提交改进版。需注意,Good second issue类PR的合并难度通常高于good first issues。在需要帮助的时候请不要犹豫,大胆的向核心维护者询问。
管道(pipelines)、模型(models)和调度器(schedulers)是Diffusers库中最重要的组成部分。它们提供了对最先进diffusion技术的便捷访问,使得社区能够构建强大的生成式AI应用。
通过添加新的模型、管道或调度器,您可能为依赖Diffusers的任何用户界面开启全新的强大用例,这对整个生成式AI生态系统具有巨大价值。
Diffusers针对这三类组件都有一些开放的功能请求——如果您还不确定要添加哪个具体组件,可以浏览以下链接:
在添加任何组件之前,强烈建议您阅读设计哲学指南,以更好地理解这三类组件的设计理念。请注意,如果添加的模型、调度器或管道与我们的设计理念存在严重分歧,我们将无法合并,因为这会导致API不一致。如果您从根本上不同意某个设计选择,请改为提交反馈问题,以便讨论是否应该更改库中的特定设计模式/选择,以及是否更新我们的设计哲学。保持库内的一致性对我们非常重要。
请确保在PR中添加原始代码库/论文的链接,并最好直接在PR中@原始作者,以便他们可以跟踪进展并在有疑问时提供帮助。
如果您在PR过程中遇到不确定或卡住的情况,请随时留言请求初步审查或帮助。
在添加任何管道、模型或调度器代码时,理解# Copied from机制是独特且重要的。您会在整个Diffusers代码库中看到这种机制,我们使用它的原因是为了保持代码库易于理解和维护。用# Copied from机制标记代码会强制标记的代码与复制来源的代码完全相同。这使得每当您运行make fix-copies时,可以轻松更新并将更改传播到多个文件。
例如,在下面的代码示例中,StableDiffusionPipelineOutput是原始代码,而AltDiffusionPipelineOutput使用# Copied from机制来复制它。唯一的区别是将类前缀从Stable改为Alt。
# 从 diffusers.pipelines.stable_diffusion.pipeline_output.StableDiffusionPipelineOutput 复制并将 Stable 替换为 Alt
class AltDiffusionPipelineOutput(BaseOutput):
"""
Output class for Alt Diffusion pipelines.
Args:
images (`List[PIL.Image.Image]` or `np.ndarray`)
List of denoised PIL images of length `batch_size` or NumPy array of shape `(batch_size, height, width,
num_channels)`.
nsfw_content_detected (`List[bool]`)
List indicating whether the corresponding generated image contains "not-safe-for-work" (nsfw) content or
`None` if safety checking could not be performed.
"""要了解更多信息,请阅读~不要~重复自己*博客文章的相应部分。
问题描述越清晰,被快速解决的可能性就越高。
[WIP]前缀。这既能避免重复劳动,也可与待合并PR明确区分;@slow测试,请使用RUN_SLOW=1 python -m pytest tests/test_my_new_model.py确保通过。
CircleCI不执行慢速测试,但GitHub Actions会每日夜间运行!pipeline_latent_diffusion.pydataset(例如hf-internal-testing或huggingface/documentation-images)存放这类文件。若为外部贡献,可将图片添加到PR中并请Hugging Face成员将其迁移至该数据集。编写代码前,强烈建议先搜索现有PR或issue,确认没有重复工作。如有疑问,建议先创建issue获取反馈。
贡献至🧨 Diffusers需要基本的git技能。虽然git学习曲线较高,但其拥有最完善的手册。在终端输入git --help即可查阅,或参考书籍Pro Git。
请按以下步骤操作(支持的Python版本):
在仓库页面点击”Fork”按钮创建代码副本至您的GitHub账户
克隆fork到本地,并添加主仓库为远程源:
$ git clone git@github.com:<您的GitHub账号>/diffusers.git
$ cd diffusers
$ git remote add upstream https://github.com/huggingface/diffusers.git创建新分支进行开发:
$ git checkout -b 您的开发分支名称
禁止直接在main分支上修改
在虚拟环境中运行以下命令配置开发环境:
$ pip install -e ".[dev]"若已克隆仓库,可能需要先执行git pull获取最新代码
在您的分支上开发功能
开发过程中应确保测试通过。可运行受影响测试:
$ pytest tests/<待测文件>.py
执行测试前请安装测试依赖:
$ pip install -e ".[test]"也可运行完整测试套件(需高性能机器):
$ make test🧨 Diffusers使用black和isort工具保持代码风格统一。修改后请执行自动化格式校正与代码验证,以下内容无法通过以下命令一次性自动化完成:
$ make style
🧨 Diffusers 还使用 ruff 和一些自定义脚本来检查代码错误。虽然质量控制流程会在 CI 中运行,但您也可以通过以下命令手动执行相同的检查:
$ make quality
当您对修改满意后,使用 git add 添加更改的文件,并通过 git commit 在本地记录这些更改:
$ git add modified_file.py
$ git commit -m "关于您所做更改的描述性信息。"定期将您的代码副本与原始仓库同步是一个好习惯。这样可以快速适应上游变更:
$ git pull upstream main
使用以下命令将更改推送到您的账户:
$ git push -u origin 此处替换为您的描述性分支名称
确认无误后,请访问您 GitHub 账户中的派生仓库页面。点击「Pull request」将您的更改提交给项目维护者审核。
如果维护者要求修改,这很正常——核心贡献者也会遇到这种情况!为了让所有人能在 Pull request 中看到变更,请在本地分支继续工作并将修改推送到您的派生仓库,这些变更会自动出现在 Pull request 中。
我们提供了全面的测试套件来验证库行为和多个示例。库测试位于 tests 文件夹。
我们推荐使用 pytest 和 pytest-xdist,因为它们速度更快。在仓库根目录下运行以下命令执行库测试:
$ python -m pytest -n auto --dist=loadfile -s -v ./tests/
实际上,这就是 make test 的实现方式!
您可以指定更小的测试范围来仅验证您正在开发的功能。
默认情况下会跳过耗时测试。设置 RUN_SLOW 环境变量为 yes 可运行这些测试。注意:这将下载数十 GB 的模型文件——请确保您有足够的磁盘空间、良好的网络连接或充足的耐心!
$ RUN_SLOW=yes python -m pytest -n auto --dist=loadfile -s -v ./tests/我们也完全支持 unittest,运行方式如下:
$ python -m unittest discover -s tests -t . -v $ python -m unittest discover -s examples -t examples -v
为避免向上游仓库发送引用通知(这会给相关 PR 添加注释并向开发者发送不必要的通知),在同步派生仓库的 main 分支时,请遵循以下步骤:
$ git checkout -b 您的同步分支名称
$ git pull --squash --no-commit upstream main
$ git commit -m '提交信息(不要包含 GitHub 引用)'
$ git push --set-upstream origin 您的分支名称对于文档字符串,🧨 Diffusers 遵循 Google 风格指南。
< > Update on GitHub