Fix typos, improve, update at main-page files and .github files (#5588) · rafaelsf80/diffusers@3b37488 · GitHub
Skip to content

Commit 3b37488

Browse files
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>
1 parent c7260ce commit 3b37488

16 files changed

Lines changed: 182 additions & 116 deletions

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 6 additions & 6 deletions

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
contact_links:
2-
- name: Blank issue
3-
url: https://github.com/huggingface/diffusers/issues/new
4-
about: Other
52
- name: Forum
6-
url: https://discuss.huggingface.co/
7-
about: General usage questions and community discussions
3+
url: https://discuss.huggingface.co/c/discussion-related-to-httpsgithubcomhuggingfacediffusers/63
4+
about: General usage questions and community discussions
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: "\U0001F680 Feature request"
2+
name: "\U0001F680 Feature Request"
33
about: Suggest an idea for this project
44
title: ''
55
labels: ''
@@ -8,13 +8,13 @@ assignees: ''
88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...].
1212

13-
**Describe the solution you'd like**
13+
**Describe the solution you'd like.**
1414
A clear and concise description of what you want to happen.
1515

16-
**Describe alternatives you've considered**
16+
**Describe alternatives you've considered.**
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

19-
**Additional context**
19+
**Additional context.**
2020
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/new-model-addition.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: "\U0001F31F New model/pipeline/scheduler addition"
2-
description: Submit a proposal/request to implement a new diffusion model / pipeline / scheduler
1+
name: "\U0001F31F New Model/Pipeline/Scheduler Addition"
2+
description: Submit a proposal/request to implement a new diffusion model/pipeline/scheduler
33
labels: [ "New model/pipeline/scheduler" ]
44

55
body:
@@ -19,7 +19,7 @@ body:
1919
description: |
2020
Please note that if the model implementation isn't available or if the weights aren't open-source, we are less likely to implement it in `diffusers`.
2121
options:
22-
- label: "The model implementation is available"
22+
- label: "The model implementation is available."
2323
- label: "The model weights are available (Only relevant if addition is not a scheduler)."
2424

2525
- type: textarea
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: 🌐 Translating a New Language?
3+
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).
28+
29+
Thank you so much for your help! 🤗

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Fixes # (issue)
1919
- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
2020
- [ ] Did you read the [contributor guideline](https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md)?
2121
- [ ] 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.
2323
- [ ] Did you make sure to update the documentation with your changes? Here are the
2424
[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).
2626
- [ ] Did you write any new necessary tests?
2727

2828

@@ -31,7 +31,7 @@ Fixes # (issue)
3131
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
3232
members/contributors who may be interested in your PR.
3333

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 @.
3535
3636
If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**.
3737
Please tag fewer than 3 people.

‎.github/actions/setup-miniconda/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Sets up miniconda in your ${RUNNER_TEMP} environment and gives you
44

55
inputs:
66
python-version:
7-
description: If set to any value, dont use sudo to clean the workspace
7+
description: If set to any value, don't use sudo to clean the workspace
88
required: false
99
type: string
1010
default: "3.9"

‎.gitignore‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Initially taken from Github's Python gitignore file
1+
# Initially taken from GitHub's Python gitignore file
22

33
# Byte-compiled / optimized / DLL files
44
__pycache__/
@@ -34,7 +34,7 @@ wheels/
3434
MANIFEST
3535

3636
# PyInstaller
37-
# Usually these files are written by a python script from a template
37+
# Usually these files are written by a Python script from a template
3838
# before PyInstaller builds the exe, so as to inject date/other infos into it.
3939
*.manifest
4040
*.spec
@@ -153,7 +153,7 @@ debug.env
153153
# vim
154154
.*.swp
155155

156-
#ctags
156+
# ctags
157157
tags
158158

159159
# pre-commit
@@ -164,6 +164,7 @@ tags
164164

165165
# DS_Store (MacOS)
166166
.DS_Store
167+
167168
# RL pipelines may produce mp4 outputs
168169
*.mp4
169170

@@ -173,4 +174,5 @@ tags
173174
# ruff
174175
.ruff_cache
175176

176-
wandb
177+
# wandb
178+
wandb

‎CITATION.cff‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@ keywords:
3131
- deep-learning
3232
- pytorch
3333
- image-generation
34+
- hacktoberfest
3435
- diffusion
3536
- text2image
3637
- image2image
3738
- score-based-generative-modeling
3839
- stable-diffusion
40+
- stable-diffusion-diffusers
3941
license: Apache-2.0
4042
version: 0.12.1

‎CODE_OF_CONDUCT.md‎

Lines changed: 4 additions & 4 deletions

0 commit comments

Comments
 (0)