diff --git a/docs/zh/README.md b/docs/zh/README.md index c02665f..b0f3d72 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -26,58 +26,58 @@ graph LR; 本节介绍 `DiffSynth-Studio` 的基本使用方式,包括如何启用显存管理从而在极低显存的 GPU 上进行推理,以及如何训练任意基础模型、LoRA、ControlNet 等模型。 -* [安装依赖](/docs/zh/Pipeline_Usage/Setup.md) -* [模型推理](/docs/zh/Pipeline_Usage/Model_Inference.md) -* [显存管理](/docs/zh/Pipeline_Usage/VRAM_management.md) -* [模型训练](/docs/zh/Pipeline_Usage/Model_Training.md) -* [环境变量](/docs/zh/Pipeline_Usage/Environment_Variables.md) -* [GPU/NPU 支持](/docs/zh/Pipeline_Usage/GPU_support.md) +* [安装依赖](Pipeline_Usage/Setup.md) +* [模型推理](Pipeline_Usage/Model_Inference.md) +* [显存管理](Pipeline_Usage/VRAM_management.md) +* [模型训练](Pipeline_Usage/Model_Training.md) +* [环境变量](Pipeline_Usage/Environment_Variables.md) +* [GPU/NPU 支持](Pipeline_Usage/GPU_support.md) ## Section 2: 模型详解 本节介绍 `DiffSynth-Studio` 所支持的 Diffusion 模型,部分模型 Pipeline 具备可控生成、并行加速等特色功能。 -* [FLUX.1](/docs/zh/Model_Details/FLUX.md) -* [Wan](/docs/zh/Model_Details/Wan.md) -* [Qwen-Image](/docs/zh/Model_Details/Qwen-Image.md) -* [FLUX.2](/docs/zh/Model_Details/FLUX2.md) -* [Z-Image](/docs/zh/Model_Details/Z-Image.md) +* [FLUX.1](Model_Details/FLUX.md) +* [Wan](Model_Details/Wan.md) +* [Qwen-Image](Model_Details/Qwen-Image.md) +* [FLUX.2](Model_Details/FLUX2.md) +* [Z-Image](Model_Details/Z-Image.md) ## Section 3: 训练框架 本节介绍 `DiffSynth-Studio` 中训练框架的设计思路,帮助开发者理解 Diffusion 模型训练算法的原理。 -* [Diffusion 模型基本原理](/docs/zh/Training/Understanding_Diffusion_models.md) -* [标准监督训练](/docs/zh/Training/Supervised_Fine_Tuning.md) -* [在训练中启用 FP8 精度](/docs/zh/Training/FP8_Precision.md) -* [端到端的蒸馏加速训练](/docs/zh/Training/Direct_Distill.md) -* [两阶段拆分训练](/docs/zh/Training/Split_Training.md) -* [差分 LoRA 训练](/docs/zh/Training/Differential_LoRA.md) +* [Diffusion 模型基本原理](Training/Understanding_Diffusion_models.md) +* [标准监督训练](Training/Supervised_Fine_Tuning.md) +* [在训练中启用 FP8 精度](Training/FP8_Precision.md) +* [端到端的蒸馏加速训练](Training/Direct_Distill.md) +* [两阶段拆分训练](Training/Split_Training.md) +* [差分 LoRA 训练](Training/Differential_LoRA.md) ## Section 4: 模型接入 本节介绍如何将模型接入 `DiffSynth-Studio` 从而使用框架基础功能,帮助开发者为本项目提供新模型的支持,或进行私有化模型的推理和训练。 -* [接入模型结构](/docs/zh/Developer_Guide/Integrating_Your_Model.md) -* [接入 Pipeline](/docs/zh/Developer_Guide/Building_a_Pipeline.md) -* [接入细粒度显存管理](/docs/zh/Developer_Guide/Enabling_VRAM_management.md) -* [接入模型训练](/docs/zh/Developer_Guide/Training_Diffusion_Models.md) +* [接入模型结构](Developer_Guide/Integrating_Your_Model.md) +* [接入 Pipeline](Developer_Guide/Building_a_Pipeline.md) +* [接入细粒度显存管理](Developer_Guide/Enabling_VRAM_management.md) +* [接入模型训练](Developer_Guide/Training_Diffusion_Models.md) ## Section 5: API 参考 本节介绍 `DiffSynth-Studio` 中的独立核心模块 `diffsynth.core`,介绍内部的功能是如何设计和运作的,开发者如有需要,可将其中的功能模块用于其他代码库的开发中。 -* [`diffsynth.core.attention`](/docs/zh/API_Reference/core/attention.md): 注意力机制实现 -* [`diffsynth.core.data`](/docs/zh/API_Reference/core/data.md): 数据处理算子与通用数据集 -* [`diffsynth.core.gradient`](/docs/zh/API_Reference/core/gradient.md): 梯度检查点 -* [`diffsynth.core.loader`](/docs/zh/API_Reference/core/loader.md): 模型下载与加载 -* [`diffsynth.core.vram`](/docs/zh/API_Reference/core/vram.md): 显存管理 +* [`diffsynth.core.attention`](API_Reference/core/attention.md): 注意力机制实现 +* [`diffsynth.core.data`](API_Reference/core/data.md): 数据处理算子与通用数据集 +* [`diffsynth.core.gradient`](API_Reference/core/gradient.md): 梯度检查点 +* [`diffsynth.core.loader`](API_Reference/core/loader.md): 模型下载与加载 +* [`diffsynth.core.vram`](API_Reference/core/vram.md): 显存管理 ## Section 6: 学术导引 本节介绍如何利用 `DiffSynth-Studio` 训练新的模型,帮助科研工作者探索新的模型技术。 -* [从零开始训练模型](/docs/zh/Research_Tutorial/train_from_scratch.md) +* [从零开始训练模型](Research_Tutorial/train_from_scratch.md) * 推理改进优化技术【coming soon】 * 设计可控生成模型【coming soon】 * 创建新的训练范式【coming soon】 @@ -86,4 +86,4 @@ graph LR; 本节总结了开发者常见的问题,如果你在使用和开发中遇到了问题,请参考本节内容,如果仍无法解决,请到 GitHub 上给我们提 issue。 -* [常见问题](/docs/zh/QA.md) +* [常见问题](QA.md) diff --git a/docs/zh/index.rst b/docs/zh/index.rst index 134ed35..b209cb1 100644 --- a/docs/zh/index.rst +++ b/docs/zh/index.rst @@ -1,44 +1,16 @@ DiffSynth-Studio 文档 ===================== -.. image:: https://img.shields.io/badge/license-Apache%202.0-blue - :target: https://github.com/modelscope/DiffSynth-Studio/blob/main/LICENSE - :alt: GitHub +.. toctree:: + :maxdepth: 2 + :caption: 文档介绍 -.. image:: https://img.shields.io/github/stars/modelscope/DiffSynth-Studio?style=social - :target: https://github.com/modelscope/DiffSynth-Studio - :alt: GitHub Repo stars - -欢迎来到 Diffusion 模型的魔法世界!`DiffSynth-Studio` 是由 `魔搭社区 `_ 团队开发和维护的开源 Diffusion 模型引擎。我们期望构建一个通用的 Diffusion 模型框架,以框架建设孵化技术创新,凝聚开源社区的力量,探索生成式模型技术的边界! - -.. raw:: html - -
- 文档阅读导引 - - ```mermaid - graph LR; - 我想要使用模型进行推理和训练-->sec1[Section 1: 上手使用]; - 我想要使用模型进行推理和训练-->sec2[Section 2: 模型详解]; - 我想要使用模型进行推理和训练-->sec3[Section 3: 训练框架]; - 我想要基于此框架进行二次开发-->sec3[Section 3: 训练框架]; - 我想要基于此框架进行二次开发-->sec4[Section 4: 模型接入]; - 我想要基于此框架进行二次开发-->sec5[Section 5: API 参考]; - 我想要基于本项目探索新的技术-->sec4[Section 4: 模型接入]; - 我想要基于本项目探索新的技术-->sec5[Section 5: API 参考]; - 我想要基于本项目探索新的技术-->sec6[Section 6: 学术导引]; - 我遇到了问题-->sec7[Section 7: 常见问题]; - ``` - -
- -Section 1: 上手使用 -------------------- - -本节介绍 ``DiffSynth-Studio`` 的基本使用方式,包括如何启用显存管理从而在极低显存的 GPU 上进行推理,以及如何训练任意基础模型、LoRA、ControlNet 等模型。 + README + QA .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 上手使用 Pipeline_Usage/Setup Pipeline_Usage/Model_Inference @@ -47,13 +19,9 @@ Section 1: 上手使用 Pipeline_Usage/Environment_Variables Pipeline_Usage/GPU_support -Section 2: 模型详解 -------------------- - -本节介绍 ``DiffSynth-Studio`` 所支持的 Diffusion 模型,部分模型 Pipeline 具备可控生成、并行加速等特色功能。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 模型详解 Model_Details/FLUX Model_Details/Wan @@ -61,13 +29,9 @@ Section 2: 模型详解 Model_Details/FLUX2 Model_Details/Z-Image -Section 3: 训练框架 -------------------- - -本节介绍 ``DiffSynth-Studio`` 中训练框架的设计思路,帮助开发者理解 Diffusion 模型训练算法的原理。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 训练框架 Training/Understanding_Diffusion_models Training/Supervised_Fine_Tuning @@ -76,26 +40,18 @@ Section 3: 训练框架 Training/Split_Training Training/Differential_LoRA -Section 4: 模型接入 -------------------- - -本节介绍如何将模型接入 ``DiffSynth-Studio`` 从而使用框架基础功能,帮助开发者为本项目提供新模型的支持,或进行私有化模型的推理和训练。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 模型接入 Developer_Guide/Integrating_Your_Model Developer_Guide/Building_a_Pipeline Developer_Guide/Enabling_VRAM_management Developer_Guide/Training_Diffusion_Models -Section 5: API 参考 -------------------- - -本节介绍 ``DiffSynth-Studio`` 中的独立核心模块 ``diffsynth.core``,介绍内部的功能是如何设计和运作的,开发者如有需要,可将其中的功能模块用于其他代码库的开发中。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: API 参考 API_Reference/core/attention API_Reference/core/data @@ -103,25 +59,20 @@ Section 5: API 参考 API_Reference/core/loader API_Reference/core/vram -Section 6: 学术导引 -------------------- - -本节介绍如何利用 ``DiffSynth-Studio`` 训练新的模型,帮助科研工作者探索新的模型技术。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 学术导引 Research_Tutorial/train_from_scratch -Section 7: 常见问题 -------------------- - -本节总结了开发者常见的问题,如果你在使用和开发中遇到了问题,请参考本节内容,如果仍无法解决,请到 GitHub 上给我们提 issue。 - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: 常见问题 QA -.. note:: - 本文档持续更新中,如有任何问题或建议,请在 `GitHub Issues `_ 中提出。 +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`