From df80ccf7de4cd7409141fe881fd4d630cd69fc4c Mon Sep 17 00:00:00 2001 From: Ryan Russell Date: Fri, 23 Sep 2022 05:02:27 -0500 Subject: [PATCH] docs: `.md` readability fixups (#619) Signed-off-by: Ryan Russell --- docs/source/api/pipelines/overview.mdx | 2 +- docs/source/using-diffusers/configuration.mdx | 2 +- docs/source/using-diffusers/unconditional_image_generation.mdx | 2 +- src/diffusers/pipelines/README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/api/pipelines/overview.mdx b/docs/source/api/pipelines/overview.mdx index dcd788e69d..a9b1bb2821 100644 --- a/docs/source/api/pipelines/overview.mdx +++ b/docs/source/api/pipelines/overview.mdx @@ -85,7 +85,7 @@ not be used for training. If you want to store the gradients during the forward We are more than happy about any contribution to the officially supported pipelines 🤗. We aspire all of our pipelines to be **self-contained**, **easy-to-tweak**, **beginner-friendly** and for **one-purpose-only**. -- **Self-contained**: A pipeline shall be as self-contained as possible. More specifically, this means that all functionality should be either directly defined in the pipeline file iteslf, should be inherited from (and only from) the [`DiffusionPipeline` class](.../diffusion_pipeline) or be directly attached to the model and scheduler components of the pipeline. +- **Self-contained**: A pipeline shall be as self-contained as possible. More specifically, this means that all functionality should be either directly defined in the pipeline file itself, should be inherited from (and only from) the [`DiffusionPipeline` class](.../diffusion_pipeline) or be directly attached to the model and scheduler components of the pipeline. - **Easy-to-use**: Pipelines should be extremely easy to use - one should be able to load the pipeline and use it for its designated task, *e.g.* text-to-image generation, in just a couple of lines of code. Most logic including pre-processing, an unrolled diffusion loop, and post-processing should all happen inside the `__call__` method. diff --git a/docs/source/using-diffusers/configuration.mdx b/docs/source/using-diffusers/configuration.mdx index 044f3937b9..a64cce0606 100644 --- a/docs/source/using-diffusers/configuration.mdx +++ b/docs/source/using-diffusers/configuration.mdx @@ -27,6 +27,6 @@ pip install diffusers ### Schedulers -### Pipeliens +### Pipelines diff --git a/docs/source/using-diffusers/unconditional_image_generation.mdx b/docs/source/using-diffusers/unconditional_image_generation.mdx index 8f5449f8fb..ba119defb8 100644 --- a/docs/source/using-diffusers/unconditional_image_generation.mdx +++ b/docs/source/using-diffusers/unconditional_image_generation.mdx @@ -12,7 +12,7 @@ specific language governing permissions and limitations under the License. -# Unonditional Image Generation +# Unconditional Image Generation The [`DiffusionPipeline`] is the easiest way to use a pre-trained diffusion system for inference diff --git a/src/diffusers/pipelines/README.md b/src/diffusers/pipelines/README.md index 7957a8c364..3462f5ff51 100644 --- a/src/diffusers/pipelines/README.md +++ b/src/diffusers/pipelines/README.md @@ -73,7 +73,7 @@ not be used for training. If you want to store the gradients during the forward We are more than happy about any contribution to the officially supported pipelines 🤗. We aspire all of our pipelines to be **self-contained**, **easy-to-tweak**, **beginner-friendly** and for **one-purpose-only**. -- **Self-contained**: A pipeline shall be as self-contained as possible. More specifically, this means that all functionality should be either directly defined in the pipeline file iteslf, should be inherited from (and only from) the [`DiffusionPipeline` class](https://github.com/huggingface/diffusers/blob/5cbed8e0d157f65d3ddc2420dfd09f2df630e978/src/diffusers/pipeline_utils.py#L56) or be directly attached to the model and scheduler components of the pipeline. +- **Self-contained**: A pipeline shall be as self-contained as possible. More specifically, this means that all functionality should be either directly defined in the pipeline file itself, should be inherited from (and only from) the [`DiffusionPipeline` class](https://github.com/huggingface/diffusers/blob/5cbed8e0d157f65d3ddc2420dfd09f2df630e978/src/diffusers/pipeline_utils.py#L56) or be directly attached to the model and scheduler components of the pipeline. - **Easy-to-use**: Pipelines should be extremely easy to use - one should be able to load the pipeline and use it for its designated task, *e.g.* text-to-image generation, in just a couple of lines of code. Most logic including pre-processing, an unrolled diffusion loop, and post-processing should all happen inside the `__call__` method.