You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/api/pipelines/overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ not be used for training. If you want to store the gradients during the forward
82
82
83
83
## Contribution
84
84
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
86
86
all of our pipelines to be **self-contained**, **easy-to-tweak**, **beginner-friendly** and for **one-purpose-only**.
87
87
88
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.
Copy file name to clipboardExpand all lines: docs/source/conceptual/contribution.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ You can contribute in so many ways! Just to name a few:
35
35
36
36
*All are equally valuable to the community.*
37
37
38
-
### Browse github issues for suggestions
38
+
### Browse GitHub issues for suggestions
39
39
40
40
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:
41
41
@@ -56,7 +56,7 @@ The 🧨 Diffusers library is robust and reliable thanks to the users who notify
56
56
the problems they encounter. So thank you for reporting an issue.
57
57
58
58
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).
60
60
61
61
### Do you want to implement a new diffusion pipeline / diffusion model?
62
62
@@ -127,7 +127,7 @@ Follow these steps to start contributing ([supported Python versions](https://gi
127
127
$ pip install -e ".[dev]"
128
128
```
129
129
130
-
(If diffusers was already installed in the virtual environment, remove
130
+
(If Diffusers was already installed in the virtual environment, remove
131
131
it with `pip uninstall diffusers` before reinstalling it in editable
132
132
mode with the `-e` flag.)
133
133
@@ -231,7 +231,7 @@ Follow these steps to start contributing ([supported Python versions](https://gi
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!
235
235
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.
236
236
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
237
237
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).
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,
276
276
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.
278
278
2. If a PR is absolutely necessary, use the following steps after checking out your branch:
Copy file name to clipboardExpand all lines: docs/source/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ specific language governing permissions and limitations under the License.
23
23
More precisely, 🤗 Diffusers offers:
24
24
25
25
- 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).
27
27
- 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
28
28
- Training examples to show how to train the most popular diffusion model tasks. For more information see [**Training**](./training/overview).
0 commit comments