Skip to content

Commit cf6522c

Browse files
stevhliuJimmy
authored and
Jimmy
committed
[docs] Reorganize table of contents (huggingface#2671)
* reorg toc * reorg toc some more * remove duplicate config
1 parent 515f626 commit cf6522c

File tree

4 files changed

+27
-48
lines changed

4 files changed

+27
-48
lines changed

docs/source/en/_toctree.yml

+22-24
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
- sections:
1212
- local: tutorials/tutorial_overview
1313
title: Overview
14+
- local: using-diffusers/write_own_pipeline
15+
title: Understanding models and schedulers
1416
- local: tutorials/basic_training
1517
title: Train a diffusion model
1618
title: Tutorials
@@ -19,21 +21,17 @@
1921
- local: using-diffusers/loading_overview
2022
title: Overview
2123
- local: using-diffusers/loading
22-
title: Loading Pipelines, Models, and Schedulers
24+
title: Load pipelines, models, and schedulers
2325
- local: using-diffusers/schedulers
24-
title: Using different Schedulers
25-
- local: using-diffusers/configuration
26-
title: Configuring Pipelines, Models, and Schedulers
26+
title: Load and compare different schedulers
2727
- local: using-diffusers/custom_pipeline_overview
28-
title: Loading and Adding Custom Pipelines
28+
title: Load and add custom pipelines
2929
- local: using-diffusers/kerascv
30-
title: Using KerasCV Stable Diffusion Checkpoints in Diffusers
30+
title: Load KerasCV Stable Diffusion checkpoints
3131
title: Loading & Hub
3232
- sections:
3333
- local: using-diffusers/pipeline_overview
3434
title: Overview
35-
- local: using-diffusers/write_own_pipeline
36-
title: Understanding models and schedulers
3735
- local: using-diffusers/unconditional_image_generation
3836
title: Unconditional Image Generation
3937
- local: using-diffusers/conditional_image_generation
@@ -44,8 +42,6 @@
4442
title: Text-Guided Image-Inpainting
4543
- local: using-diffusers/depth2img
4644
title: Text-Guided Depth-to-Image
47-
- local: using-diffusers/controlling_generation
48-
title: Controlling generation
4945
- local: using-diffusers/reusing_seeds
5046
title: Reusing seeds for deterministic generation
5147
- local: using-diffusers/reproducibility
@@ -59,6 +55,20 @@
5955
- local: using-diffusers/weighted_prompts
6056
title: Weighting Prompts
6157
title: Pipelines for Inference
58+
- sections:
59+
- local: training/overview
60+
title: Overview
61+
- local: training/unconditional_training
62+
title: Unconditional image generation
63+
- local: training/text_inversion
64+
title: Textual Inversion
65+
- local: training/dreambooth
66+
title: DreamBooth
67+
- local: training/text2image
68+
title: Text-to-image
69+
- local: training/lora
70+
title: Low-Rank Adaptation of Large Language Models (LoRA)
71+
title: Training
6272
- sections:
6373
- local: using-diffusers/rl
6474
title: Reinforcement Learning
@@ -86,23 +96,11 @@
8696
- local: optimization/habana
8797
title: Habana Gaudi
8898
title: Optimization/Special Hardware
89-
- sections:
90-
- local: training/overview
91-
title: Overview
92-
- local: training/unconditional_training
93-
title: Unconditional image generation
94-
- local: training/text_inversion
95-
title: Textual Inversion
96-
- local: training/dreambooth
97-
title: DreamBooth
98-
- local: training/text2image
99-
title: Text-to-image
100-
- local: training/lora
101-
title: Low-Rank Adaptation of Large Language Models (LoRA)
102-
title: Training
10399
- sections:
104100
- local: conceptual/philosophy
105101
title: Philosophy
102+
- local: using-diffusers/controlling_generation
103+
title: Controlled generation
106104
- local: conceptual/contribution
107105
title: How to contribute?
108106
- local: conceptual/ethical_guidelines

docs/source/en/api/configuration.mdx

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ specific language governing permissions and limitations under the License.
1212

1313
# Configuration
1414

15-
In Diffusers, schedulers of type [`schedulers.scheduling_utils.SchedulerMixin`], and models of type [`ModelMixin`] inherit from [`ConfigMixin`] which conveniently takes care of storing all parameters that are
16-
passed to the respective `__init__` methods in a JSON-configuration file.
15+
Schedulers from [`~schedulers.scheduling_utils.SchedulerMixin`] and models from [`ModelMixin`] inherit from [`ConfigMixin`] which conveniently takes care of storing all the parameters that are
16+
passed to their respective `__init__` methods in a JSON-configuration file.
1717

1818
## ConfigMixin
1919

2020
[[autodoc]] ConfigMixin
2121
- load_config
2222
- from_config
2323
- save_config
24+
- to_json_file
25+
- to_json_string

docs/source/en/using-diffusers/configuration.mdx

-21
This file was deleted.

docs/source/en/using-diffusers/controlling_generation.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express o
1010
specific language governing permissions and limitations under the License.
1111
-->
1212

13-
# Controlling generation of diffusion models
13+
# Controlled generation
1414

1515
Controlling outputs generated by diffusion models has been long pursued by the community and is now an active research topic. In many popular diffusion models, subtle changes in inputs, both images and text prompts, can drastically change outputs. In an ideal world we want to be able to control how semantics are preserved and changed.
1616

0 commit comments

Comments
 (0)