[docs] Reorganize table of contents (#2671)
* reorg toc * reorg toc some more * remove duplicate config
This commit is contained in:
parent
a72d14fc8d
commit
588e50bc57
|
@ -11,6 +11,8 @@
|
||||||
- sections:
|
- sections:
|
||||||
- local: tutorials/tutorial_overview
|
- local: tutorials/tutorial_overview
|
||||||
title: Overview
|
title: Overview
|
||||||
|
- local: using-diffusers/write_own_pipeline
|
||||||
|
title: Understanding models and schedulers
|
||||||
- local: tutorials/basic_training
|
- local: tutorials/basic_training
|
||||||
title: Train a diffusion model
|
title: Train a diffusion model
|
||||||
title: Tutorials
|
title: Tutorials
|
||||||
|
@ -19,21 +21,17 @@
|
||||||
- local: using-diffusers/loading_overview
|
- local: using-diffusers/loading_overview
|
||||||
title: Overview
|
title: Overview
|
||||||
- local: using-diffusers/loading
|
- local: using-diffusers/loading
|
||||||
title: Loading Pipelines, Models, and Schedulers
|
title: Load pipelines, models, and schedulers
|
||||||
- local: using-diffusers/schedulers
|
- local: using-diffusers/schedulers
|
||||||
title: Using different Schedulers
|
title: Load and compare different schedulers
|
||||||
- local: using-diffusers/configuration
|
|
||||||
title: Configuring Pipelines, Models, and Schedulers
|
|
||||||
- local: using-diffusers/custom_pipeline_overview
|
- local: using-diffusers/custom_pipeline_overview
|
||||||
title: Loading and Adding Custom Pipelines
|
title: Load and add custom pipelines
|
||||||
- local: using-diffusers/kerascv
|
- local: using-diffusers/kerascv
|
||||||
title: Using KerasCV Stable Diffusion Checkpoints in Diffusers
|
title: Load KerasCV Stable Diffusion checkpoints
|
||||||
title: Loading & Hub
|
title: Loading & Hub
|
||||||
- sections:
|
- sections:
|
||||||
- local: using-diffusers/pipeline_overview
|
- local: using-diffusers/pipeline_overview
|
||||||
title: Overview
|
title: Overview
|
||||||
- local: using-diffusers/write_own_pipeline
|
|
||||||
title: Understanding models and schedulers
|
|
||||||
- local: using-diffusers/unconditional_image_generation
|
- local: using-diffusers/unconditional_image_generation
|
||||||
title: Unconditional Image Generation
|
title: Unconditional Image Generation
|
||||||
- local: using-diffusers/conditional_image_generation
|
- local: using-diffusers/conditional_image_generation
|
||||||
|
@ -44,8 +42,6 @@
|
||||||
title: Text-Guided Image-Inpainting
|
title: Text-Guided Image-Inpainting
|
||||||
- local: using-diffusers/depth2img
|
- local: using-diffusers/depth2img
|
||||||
title: Text-Guided Depth-to-Image
|
title: Text-Guided Depth-to-Image
|
||||||
- local: using-diffusers/controlling_generation
|
|
||||||
title: Controlling generation
|
|
||||||
- local: using-diffusers/reusing_seeds
|
- local: using-diffusers/reusing_seeds
|
||||||
title: Reusing seeds for deterministic generation
|
title: Reusing seeds for deterministic generation
|
||||||
- local: using-diffusers/reproducibility
|
- local: using-diffusers/reproducibility
|
||||||
|
@ -59,6 +55,20 @@
|
||||||
- local: using-diffusers/weighted_prompts
|
- local: using-diffusers/weighted_prompts
|
||||||
title: Weighting Prompts
|
title: Weighting Prompts
|
||||||
title: Pipelines for Inference
|
title: Pipelines for Inference
|
||||||
|
- sections:
|
||||||
|
- local: training/overview
|
||||||
|
title: Overview
|
||||||
|
- local: training/unconditional_training
|
||||||
|
title: Unconditional image generation
|
||||||
|
- local: training/text_inversion
|
||||||
|
title: Textual Inversion
|
||||||
|
- local: training/dreambooth
|
||||||
|
title: DreamBooth
|
||||||
|
- local: training/text2image
|
||||||
|
title: Text-to-image
|
||||||
|
- local: training/lora
|
||||||
|
title: Low-Rank Adaptation of Large Language Models (LoRA)
|
||||||
|
title: Training
|
||||||
- sections:
|
- sections:
|
||||||
- local: using-diffusers/rl
|
- local: using-diffusers/rl
|
||||||
title: Reinforcement Learning
|
title: Reinforcement Learning
|
||||||
|
@ -86,23 +96,11 @@
|
||||||
- local: optimization/habana
|
- local: optimization/habana
|
||||||
title: Habana Gaudi
|
title: Habana Gaudi
|
||||||
title: Optimization/Special Hardware
|
title: Optimization/Special Hardware
|
||||||
- sections:
|
|
||||||
- local: training/overview
|
|
||||||
title: Overview
|
|
||||||
- local: training/unconditional_training
|
|
||||||
title: Unconditional image generation
|
|
||||||
- local: training/text_inversion
|
|
||||||
title: Textual Inversion
|
|
||||||
- local: training/dreambooth
|
|
||||||
title: DreamBooth
|
|
||||||
- local: training/text2image
|
|
||||||
title: Text-to-image
|
|
||||||
- local: training/lora
|
|
||||||
title: Low-Rank Adaptation of Large Language Models (LoRA)
|
|
||||||
title: Training
|
|
||||||
- sections:
|
- sections:
|
||||||
- local: conceptual/philosophy
|
- local: conceptual/philosophy
|
||||||
title: Philosophy
|
title: Philosophy
|
||||||
|
- local: using-diffusers/controlling_generation
|
||||||
|
title: Controlled generation
|
||||||
- local: conceptual/contribution
|
- local: conceptual/contribution
|
||||||
title: How to contribute?
|
title: How to contribute?
|
||||||
- local: conceptual/ethical_guidelines
|
- local: conceptual/ethical_guidelines
|
||||||
|
|
|
@ -12,8 +12,8 @@ specific language governing permissions and limitations under the License.
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
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
|
Schedulers from [`~schedulers.scheduling_utils.SchedulerMixin`] and models from [`ModelMixin`] inherit from [`ConfigMixin`] which conveniently takes care of storing all the parameters that are
|
||||||
passed to the respective `__init__` methods in a JSON-configuration file.
|
passed to their respective `__init__` methods in a JSON-configuration file.
|
||||||
|
|
||||||
## ConfigMixin
|
## ConfigMixin
|
||||||
|
|
||||||
|
@ -21,3 +21,5 @@ passed to the respective `__init__` methods in a JSON-configuration file.
|
||||||
- load_config
|
- load_config
|
||||||
- from_config
|
- from_config
|
||||||
- save_config
|
- save_config
|
||||||
|
- to_json_file
|
||||||
|
- to_json_string
|
||||||
|
|
|
@ -1,21 +0,0 @@
|
||||||
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
|
|
||||||
the License. You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
|
|
||||||
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
|
||||||
specific language governing permissions and limitations under the License.
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
The handling of configurations in Diffusers is with the `ConfigMixin` class.
|
|
||||||
|
|
||||||
[[autodoc]] ConfigMixin
|
|
||||||
|
|
||||||
Under further construction 🚧, open a [PR](https://github.com/huggingface/diffusers/compare) if you want to contribute!
|
|
|
@ -10,7 +10,7 @@ an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express o
|
||||||
specific language governing permissions and limitations under the License.
|
specific language governing permissions and limitations under the License.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Controlling generation of diffusion models
|
# Controlled generation
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue