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
Fix typos, improve, update at main-page files and .github files (huggingface#5588)
* Update keywords; remove version cuz it changes constantly?
* Update if necessary
* Fix typos and links
* version_range_max from PyTorch's setup.py; fix typos; 1 checklist is enough?
* Fix a typo
* Fix typos
* There is already a Blank issue link at the bottom of the page; direct to Diffusers' forum
* Add 🌐 Translating a New Language? page
* Update .github/ISSUE_TEMPLATE/translate.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update PHILOSOPHY.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update PHILOSOPHY.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update PHILOSOPHY.md
* Update PHILOSOPHY.md
* Update CONTRIBUTING.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update PHILOSOPHY.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update PHILOSOPHY.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Update README.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Add X account link
* Update setup.py
* Update CITATION.cff
---------
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/bug-report.yml
+6-6
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
name: "\U0001F41B Bug Report"
2
-
description: Report a bug on diffusers
2
+
description: Report a bug on Diffusers
3
3
labels: [ "bug" ]
4
4
body:
5
5
- type: markdown
@@ -10,7 +10,7 @@ body:
10
10
Thus, issues are of the same importance as pull requests when contributing to this library ❤️.
11
11
In order to make your issue as **useful for the community as possible**, let's try to stick to some simple guidelines:
12
12
- 1. Please try to be as precise and concise as possible.
13
-
*Give your issue a fitting title. Assume that someone which very limited knowledge of diffusers can understand your issue. Add links to the source code, documentation other issues, pull requests etc...*
13
+
*Give your issue a fitting title. Assume that someone which very limited knowledge of Diffusers can understand your issue. Add links to the source code, documentation other issues, pull requests etc...*
14
14
- 2. If your issue is about something not working, **always** provide a reproducible code snippet. The reader should be able to reproduce your issue by **only copy-pasting your code snippet into a Python shell**.
15
15
*The community cannot solve your issue if it cannot reproduce it. If your bug is related to training, add your training script and make everything needed to train public. Otherwise, just add a simple Python code snippet.*
16
16
- 3. Add the **minimum** amount of code / context that is needed to understand, reproduce your issue.
@@ -19,7 +19,7 @@ body:
19
19
- type: markdown
20
20
attributes:
21
21
value: |
22
-
For more in-detail information on how to write good issues you can have a look [here](https://huggingface.co/course/chapter8/5?fw=pt)
22
+
For more in-detail information on how to write good issues you can have a look [here](https://huggingface.co/course/chapter8/5?fw=pt).
23
23
- type: textarea
24
24
id: bug-description
25
25
attributes:
@@ -47,15 +47,15 @@ body:
47
47
attributes:
48
48
label: System Info
49
49
description: Please share your system info with us. You can run the command `diffusers-cli env` and copy-paste its output below.
about: Start a new translation effort in your language
4
+
title: '[<languageCode>] Translating docs to <languageName>'
5
+
labels: WIP
6
+
assignees: ''
7
+
8
+
---
9
+
10
+
<!--
11
+
Note: Please search to see if an issue already exists for the language you are trying to translate.
12
+
-->
13
+
14
+
Hi!
15
+
16
+
Let's bring the documentation to all the <languageName>-speaking community 🌐.
17
+
18
+
Who would want to translate? Please follow the 🤗 [TRANSLATING guide](https://github.com/huggingface/diffusers/blob/main/docs/TRANSLATING.md). Here is a list of the files ready for translation. Let us know in this issue if you'd like to translate any, and we'll add your name to the list.
19
+
20
+
Some notes:
21
+
22
+
* Please translate using an informal tone (imagine you are talking with a friend about Diffusers 🤗).
23
+
* Please translate in a gender-neutral way.
24
+
* Add your translations to the folder called `<languageCode>` inside the [source folder](https://github.com/huggingface/diffusers/tree/main/docs/source).
25
+
* Register your translation in `<languageCode>/_toctree.yml`; please follow the order of the [English version](https://github.com/huggingface/diffusers/blob/main/docs/source/en/_toctree.yml).
26
+
* Once you're finished, open a pull request and tag this issue by including #issue-number in the description, where issue-number is the number of this issue. Please ping @stevhliu for review.
27
+
* 🙋 If you'd like others to help you with the translation, you can also post in the 🤗 [forums](https://discuss.huggingface.co/c/discussion-related-to-httpsgithubcomhuggingfacediffusers/63).
Copy file name to clipboardexpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -19,10 +19,10 @@ Fixes # (issue)
19
19
-[ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
20
20
-[ ] Did you read the [contributor guideline](https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md)?
21
21
-[ ] Did you read our [philosophy doc](https://github.com/huggingface/diffusers/blob/main/PHILOSOPHY.md) (important for complex PRs)?
22
-
-[ ] Was this discussed/approved via a Github issue or the [forum](https://discuss.huggingface.co/)? Please add a link to it if that's the case.
22
+
-[ ] Was this discussed/approved via a GitHub issue or the [forum](https://discuss.huggingface.co/c/discussion-related-to-httpsgithubcomhuggingfacediffusers/63)? Please add a link to it if that's the case.
23
23
-[ ] Did you make sure to update the documentation with your changes? Here are the
24
24
[documentation guidelines](https://github.com/huggingface/diffusers/tree/main/docs), and
25
-
[here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/main/docs#writing-source-documentation).
25
+
[here are tips on formatting docstrings](https://github.com/huggingface/diffusers/tree/main/docs#writing-source-documentation).
26
26
-[ ] Did you write any new necessary tests?
27
27
28
28
@@ -31,7 +31,7 @@ Fixes # (issue)
31
31
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
32
32
members/contributors who may be interested in your PR.
33
33
34
-
<!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @
34
+
<!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @.
35
35
36
36
If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**.
- State-of-the-art [diffusion pipelines](https://huggingface.co/docs/diffusers/api/pipelines/overview) that can be run in inference with just a few lines of code.
26
45
- Interchangeable noise [schedulers](https://huggingface.co/docs/diffusers/api/schedulers/overview) for different diffusion speeds and output quality.
27
-
- Pretrained [models](https://huggingface.co/docs/diffusers/api/models) that can be used as building blocks, and combined with schedulers, for creating your own end-to-end diffusion systems.
46
+
- Pretrained [models](https://huggingface.co/docs/diffusers/api/models/overview) that can be used as building blocks, and combined with schedulers, for creating your own end-to-end diffusion systems.
28
47
29
48
## Installation
30
49
@@ -58,7 +77,7 @@ Please refer to the [How to use Stable Diffusion in Apple Silicon](https://huggi
58
77
59
78
## Quickstart
60
79
61
-
Generating outputs is super easy with 🤗 Diffusers. To generate an image from text, use the `from_pretrained` method to load any pretrained diffusion model (browse the [Hub](https://huggingface.co/models?library=diffusers&sort=downloads) for 4000+ checkpoints):
80
+
Generating outputs is super easy with 🤗 Diffusers. To generate an image from text, use the `from_pretrained` method to load any pretrained diffusion model (browse the [Hub](https://huggingface.co/models?library=diffusers&sort=downloads) for 14000+ checkpoints):
Copy file name to clipboardexpand all lines: docs/TRANSLATING.md
+17-5
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,22 @@
1
+
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
2
+
3
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
4
+
the License. You may obtain a copy of the License at
5
+
6
+
http://www.apache.org/licenses/LICENSE-2.0
7
+
8
+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
9
+
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
10
+
specific language governing permissions and limitations under the License.
11
+
-->
12
+
1
13
### Translating the Diffusers documentation into your language
2
14
3
15
As part of our mission to democratize machine learning, we'd love to make the Diffusers library available in many more languages! Follow the steps below if you want to help translate the documentation into your language 🙏.
4
16
5
17
**🗞️ Open an issue**
6
18
7
-
To get started, navigate to the [Issues](https://github.com/huggingface/diffusers/issues) page of this repo and check if anyone else has opened an issue for your language. If not, open a new issue by selecting the "Translation template" from the "New issue" button.
19
+
To get started, navigate to the [Issues](https://github.com/huggingface/diffusers/issues) page of this repo and check if anyone else has opened an issue for your language. If not, open a new issue by selecting the "🌐 Translating a New Language?" from the "New issue" button.
8
20
9
21
Once an issue exists, post a comment to indicate which chapters you'd like to work on, and we'll add your name to the list.
10
22
@@ -16,7 +28,7 @@ First, you'll need to [fork the Diffusers repo](https://docs.github.com/en/get-s
16
28
Once you've forked the repo, you'll want to get the files on your local machine for editing. You can do that by cloning the fork with Git as follows:
**📋 Copy-paste the English version with a new language code**
@@ -29,18 +41,18 @@ You'll only need to copy the files in the [`docs/source/en`](https://github.com/
29
41
30
42
```bash
31
43
cd~/path/to/diffusers/docs
32
-
cp -r source/en source/LANG-ID
44
+
cp -r source/en source/<LANG-ID>
33
45
```
34
46
35
-
Here, `LANG-ID` should be one of the ISO 639-1 or ISO 639-2 language codes -- see [here](https://www.loc.gov/standards/iso639-2/php/code_list.php) for a handy table.
47
+
Here, `<LANG-ID>` should be one of the ISO 639-1 or ISO 639-2 language codes -- see [here](https://www.loc.gov/standards/iso639-2/php/code_list.php) for a handy table.
36
48
37
49
**✍️ Start translating**
38
50
39
51
The fun part comes - translating the text!
40
52
41
53
The first thing we recommend is translating the part of the `_toctree.yml` file that corresponds to your doc chapter. This file is used to render the table of contents on the website.
42
54
43
-
> 🙋 If the `_toctree.yml` file doesn't yet exist for your language, you can create one by copy-pasting from the English version and deleting the sections unrelated to your chapter. Just make sure it exists in the `docs/source/LANG-ID/` directory!
55
+
> 🙋 If the `_toctree.yml` file doesn't yet exist for your language, you can create one by copy-pasting from the English version and deleting the sections unrelated to your chapter. Just make sure it exists in the `docs/source/<LANG-ID>/` directory!
44
56
45
57
The fields you should add are `local` (with the name of the file containing the translation; e.g. `autoclass_tutorial`), and `title` (with the title of the doc in your language; e.g. `Load pretrained instances with an AutoClass`) -- as a reference, here is the `_toctree.yml` for [English](https://github.com/huggingface/diffusers/blob/main/docs/source/en/_toctree.yml):
0 commit comments