Skip to content

Commit b8894f1

Browse files
author
Nathan Lambert
authored
Docs fix some typos (#408)
* fix small typos * capitalize Diffusers
1 parent e6110f6 commit b8894f1

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/source/api/pipelines/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ not be used for training. If you want to store the gradients during the forward
8282

8383
## Contribution
8484

85-
We are more than happy about any contribution to the offically supported pipelines 🤗. We aspire
85+
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

8888
- **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.

docs/source/conceptual/contribution.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can contribute in so many ways! Just to name a few:
3535

3636
*All are equally valuable to the community.*
3737

38-
### Browse github issues for suggestions
38+
### Browse GitHub issues for suggestions
3939

4040
If you need inspiration, you can look out for [issues](https://github.com/huggingface/diffusers/issues) you'd like to tackle to contribute to the library. There are a few filters that can be helpful:
4141

@@ -56,7 +56,7 @@ The 🧨 Diffusers library is robust and reliable thanks to the users who notify
5656
the problems they encounter. So thank you for reporting an issue.
5757

5858
First, we would really appreciate it if you could **make sure the bug was not
59-
already reported** (use the search bar on Github under Issues).
59+
already reported** (use the search bar on GitHub under Issues).
6060

6161
### Do you want to implement a new diffusion pipeline / diffusion model?
6262

@@ -127,7 +127,7 @@ Follow these steps to start contributing ([supported Python versions](https://gi
127127
$ pip install -e ".[dev]"
128128
```
129129

130-
(If diffusers was already installed in the virtual environment, remove
130+
(If Diffusers was already installed in the virtual environment, remove
131131
it with `pip uninstall diffusers` before reinstalling it in editable
132132
mode with the `-e` flag.)
133133

@@ -231,7 +231,7 @@ Follow these steps to start contributing ([supported Python versions](https://gi
231231
`RUN_SLOW=1 python -m pytest tests/test_my_new_model.py`.
232232
- If you are adding a new tokenizer, write tests, and make sure
233233
`RUN_SLOW=1 python -m pytest tests/test_tokenization_{your_model_name}.py` passes.
234-
CircleCI does not run the slow tests, but github actions does every night!
234+
CircleCI does not run the slow tests, but GitHub actions does every night!
235235
6. All public methods must have informative docstrings that work nicely with sphinx. See `[pipeline_latent_diffusion.py](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/latent_diffusion/pipeline_latent_diffusion.py)` for an example.
236236
7. Due to the rapidly growing repository, it is important to make sure that no files that would significantly weigh down the repository are added. This includes images, videos and other non-text files. We prefer to leverage a hf.co hosted `dataset` like
237237
the ones hosted on [`hf-internal-testing`](https://huggingface.co/hf-internal-testing) in which to place these files and reference or [huggingface/documentation-images](https://huggingface.co/datasets/huggingface/documentation-images).
@@ -274,7 +274,7 @@ $ python -m unittest discover -s examples -t examples -v
274274

275275
To avoid pinging the upstream repository which adds reference notes to each upstream PR and sends unnecessary notifications to the developers involved in these PRs,
276276
when syncing the main branch of a forked repository, please, follow these steps:
277-
1. When possible, avoid syncing with the upstream using a branch and PR on the forked repository. Instead merge directly into the forked main.
277+
1. When possible, avoid syncing with the upstream using a branch and PR on the forked repository. Instead, merge directly into the forked main.
278278
2. If a PR is absolutely necessary, use the following steps after checking out your branch:
279279
```
280280
$ git checkout -b your-branch-for-syncing

docs/source/conceptual/philosophy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ specific language governing permissions and limitations under the License.
1313
# Philosophy
1414

1515
- Readability and clarity are preferred over highly optimized code. A strong importance is put on providing readable, intuitive and elementary code design. *E.g.*, the provided [schedulers](https://github.com/huggingface/diffusers/tree/main/src/diffusers/schedulers) are separated from the provided [models](https://github.com/huggingface/diffusers/tree/main/src/diffusers/models) and use well-commented code that can be read alongside the original paper.
16-
- Diffusers is **modality independent** and focuses on providing pretrained models and tools to build systems that generate **continous outputs**, *e.g.* vision and audio. This is one of the guiding goals even if the initial pipelines are devoted to vision tasks.
16+
- Diffusers is **modality independent** and focuses on providing pretrained models and tools to build systems that generate **continuous outputs**, *e.g.* vision and audio. This is one of the guiding goals even if the initial pipelines are devoted to vision tasks.
1717
- Diffusion models and schedulers are provided as concise, elementary building blocks. In contrast, diffusion pipelines are a collection of end-to-end diffusion systems that can be used out-of-the-box, should stay as close as possible to their original implementations and can include components of other libraries, such as text encoders. Examples of diffusion pipelines are [Glide](https://github.com/openai/glide-text2im), [Latent Diffusion](https://github.com/CompVis/latent-diffusion) and [Stable Diffusion](https://github.com/compvis/stable-diffusion).

docs/source/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ specific language governing permissions and limitations under the License.
2323
More precisely, 🤗 Diffusers offers:
2424

2525
- State-of-the-art diffusion pipelines that can be run in inference with just a couple of lines of code (see [**Using Diffusers**](./using-diffusers/conditional_image_generation)) or have a look at [**Pipelines**](#pipelines) to get an overview of all supported pipelines and their corresponding papers.
26-
- Various noise schedulers that can be used interchangeably for the prefered speed vs. quality trade-off in inference. For more information see [**Schedulers**](./api/schedulers).
26+
- Various noise schedulers that can be used interchangeably for the preferred speed vs. quality trade-off in inference. For more information see [**Schedulers**](./api/schedulers).
2727
- Multiple types of models, such as UNet, can be used as building blocks in an end-to-end diffusion system. See [**Models**](./api/models) for more details
2828
- Training examples to show how to train the most popular diffusion model tasks. For more information see [**Training**](./training/overview).
2929

0 commit comments

Comments
 (0)