Skip to content

Commit df80ccf

Browse files
authored
docs: .md readability fixups (#619)
Signed-off-by: Ryan Russell <git@ryanrussell.org>
1 parent 91db818 commit df80ccf

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/source/api/pipelines/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ not be used for training. If you want to store the gradients during the forward
8585
We are more than happy about any contribution to the officially supported pipelines 🤗. We aspire
8686
all of our pipelines to be **self-contained**, **easy-to-tweak**, **beginner-friendly** and for **one-purpose-only**.
8787

88-
- **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.
88+
- **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.
8989
- **Easy-to-use**: Pipelines should be extremely easy to use - one should be able to load the pipeline and
9090
use it for its designated task, *e.g.* text-to-image generation, in just a couple of lines of code. Most
9191
logic including pre-processing, an unrolled diffusion loop, and post-processing should all happen inside the `__call__` method.

docs/source/using-diffusers/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ pip install diffusers
2727

2828
### Schedulers
2929

30-
### Pipeliens
30+
### Pipelines
3131

3232

docs/source/using-diffusers/unconditional_image_generation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ specific language governing permissions and limitations under the License.
1212

1313

1414

15-
# Unonditional Image Generation
15+
# Unconditional Image Generation
1616

1717
The [`DiffusionPipeline`] is the easiest way to use a pre-trained diffusion system for inference
1818

src/diffusers/pipelines/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ not be used for training. If you want to store the gradients during the forward
7373
We are more than happy about any contribution to the officially supported pipelines 🤗. We aspire
7474
all of our pipelines to be **self-contained**, **easy-to-tweak**, **beginner-friendly** and for **one-purpose-only**.
7575

76-
- **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.
76+
- **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.
7777
- **Easy-to-use**: Pipelines should be extremely easy to use - one should be able to load the pipeline and
7878
use it for its designated task, *e.g.* text-to-image generation, in just a couple of lines of code. Most
7979
logic including pre-processing, an unrolled diffusion loop, and post-processing should all happen inside the `__call__` method.

0 commit comments

Comments
 (0)