mirror of
https://github.com/huggingface/diffusers.git
synced 2026-01-27 17:22:53 +03:00
Fix typos, improve, update at main-page files and .github files (#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>
This commit is contained in:
M. Tolga Cangöz
GitHub
53
setup.py
53
setup.py
@@ -15,12 +15,12 @@
|
||||
"""
|
||||
Simple check list from AllenNLP repo: https://github.com/allenai/allennlp/blob/main/setup.py
|
||||
|
||||
To create the package for pypi.
|
||||
To create the package for PyPI.
|
||||
|
||||
1. Run `make pre-release` (or `make pre-patch` for a patch release) then run `make fix-copies` to fix the index of the
|
||||
documentation.
|
||||
|
||||
If releasing on a special branch, copy the updated README.md on the main branch for your the commit you will make
|
||||
If releasing on a special branch, copy the updated README.md on the main branch for the commit you will make
|
||||
for the post-release and run `make fix-copies` on the main branch as well.
|
||||
|
||||
2. Run Tests for Amazon Sagemaker. The documentation is located in `./tests/sagemaker/README.md`, otherwise @philschmid.
|
||||
@@ -30,29 +30,29 @@ To create the package for pypi.
|
||||
4. Checkout the release branch (v<RELEASE>-release, for example v4.19-release), and commit these changes with the
|
||||
message: "Release: <RELEASE>" and push.
|
||||
|
||||
5. Wait for the tests on main to be completed and be green (otherwise revert and fix bugs)
|
||||
5. Wait for the tests on main to be completed and be green (otherwise revert and fix bugs).
|
||||
|
||||
6. Add a tag in git to mark the release: "git tag v<RELEASE> -m 'Adds tag v<RELEASE> for pypi' "
|
||||
6. Add a tag in git to mark the release: "git tag v<RELEASE> -m 'Adds tag v<RELEASE> for PyPI'"
|
||||
Push the tag to git: git push --tags origin v<RELEASE>-release
|
||||
|
||||
7. Build both the sources and the wheel. Do not change anything in setup.py between
|
||||
creating the wheel and the source distribution (obviously).
|
||||
|
||||
For the wheel, run: "python setup.py bdist_wheel" in the top level directory.
|
||||
(this will build a wheel for the python version you use to build it).
|
||||
For the wheel, run: "python setup.py bdist_wheel" in the top level directory
|
||||
(This will build a wheel for the Python version you use to build it).
|
||||
|
||||
For the sources, run: "python setup.py sdist"
|
||||
You should now have a /dist directory with both .whl and .tar.gz source versions.
|
||||
|
||||
Long story cut short, you need to run both before you can upload the distribution to the
|
||||
test pypi and the actual pypi servers:
|
||||
test PyPI and the actual PyPI servers:
|
||||
|
||||
python setup.py bdist_wheel && python setup.py sdist
|
||||
|
||||
8. Check that everything looks correct by uploading the package to the pypi test server:
|
||||
8. Check that everything looks correct by uploading the package to the PyPI test server:
|
||||
|
||||
twine upload dist/* -r pypitest
|
||||
(pypi suggest using twine as other methods upload files via plaintext.)
|
||||
(pypi suggests using twine as other methods upload files via plaintext.)
|
||||
You may have to specify the repository url, use the following command then:
|
||||
twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/
|
||||
|
||||
@@ -64,20 +64,21 @@ To create the package for pypi.
|
||||
pip install -i https://testpypi.python.org/pypi diffusers
|
||||
|
||||
Check you can run the following commands:
|
||||
python -c "python -c "from diffusers import __version__; print(__version__)"
|
||||
python -c "from diffusers import __version__; print(__version__)"
|
||||
python -c "from diffusers import DiffusionPipeline; pipe = DiffusionPipeline.from_pretrained('fusing/unet-ldm-dummy-update'); pipe()"
|
||||
python -c "from diffusers import DiffusionPipeline; pipe = DiffusionPipeline.from_pretrained('hf-internal-testing/tiny-stable-diffusion-pipe', safety_checker=None); pipe('ah suh du')"
|
||||
python -c "from diffusers import *"
|
||||
|
||||
9. Upload the final version to actual pypi:
|
||||
9. Upload the final version to the actual PyPI:
|
||||
twine upload dist/* -r pypi
|
||||
|
||||
10. Prepare the release notes and publish them on github once everything is looking hunky-dory.
|
||||
10. Prepare the release notes and publish them on GitHub once everything is looking hunky-dory.
|
||||
|
||||
11. Run `make post-release` (or, for a patch release, `make post-patch`). If you were on a branch for the release,
|
||||
you need to go back to main before executing this.
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import re
|
||||
from distutils.core import Command
|
||||
@@ -142,7 +143,7 @@ deps = {b: a for a, b in (re.findall(r"^(([^!=<>~]+)(?:[!=<>~].*)?$)", x)[0] for
|
||||
# anywhere. If you need to quickly access the data from this table in a shell, you can do so easily with:
|
||||
#
|
||||
# python -c 'import sys; from diffusers.dependency_versions_table import deps; \
|
||||
# print(" ".join([ deps[x] for x in sys.argv[1:]]))' tokenizers datasets
|
||||
# print(" ".join([deps[x] for x in sys.argv[1:]]))' tokenizers datasets
|
||||
#
|
||||
# Just pass the desired package names to that script as it's shown with 2 packages above.
|
||||
#
|
||||
@@ -151,7 +152,7 @@ deps = {b: a for a, b in (re.findall(r"^(([^!=<>~]+)(?:[!=<>~].*)?$)", x)[0] for
|
||||
# You can then feed this for example to `pip`:
|
||||
#
|
||||
# pip install -U $(python -c 'import sys; from diffusers.dependency_versions_table import deps; \
|
||||
# print(" ".join([ deps[x] for x in sys.argv[1:]]))' tokenizers datasets)
|
||||
# print(" ".join([deps[x] for x in sys.argv[1:]]))' tokenizers datasets)
|
||||
#
|
||||
|
||||
|
||||
@@ -182,7 +183,7 @@ class DepsTableUpdateCommand(Command):
|
||||
content = [
|
||||
"# THIS FILE HAS BEEN AUTOGENERATED. To update:",
|
||||
"# 1. modify the `_deps` dict in setup.py",
|
||||
"# 2. run `make deps_table_update``",
|
||||
"# 2. run `make deps_table_update`",
|
||||
"deps = {",
|
||||
entries,
|
||||
"}",
|
||||
@@ -194,7 +195,6 @@ class DepsTableUpdateCommand(Command):
|
||||
f.write("\n".join(content))
|
||||
|
||||
|
||||
extras = {}
|
||||
|
||||
|
||||
extras = {}
|
||||
@@ -242,6 +242,8 @@ install_requires = [
|
||||
deps["Pillow"],
|
||||
]
|
||||
|
||||
version_range_max = max(sys.version_info[1], 10) + 1
|
||||
|
||||
setup(
|
||||
name="diffusers",
|
||||
version="0.24.0.dev0", # expected format is one of x.y.z.dev0, or x.y.z.rc1 or x.y.z (no to dashes, yes to dots)
|
||||
@@ -268,30 +270,33 @@ setup(
|
||||
"Intended Audience :: Science/Research",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
||||
"Programming Language :: Python :: 3",
|
||||
]
|
||||
+ [
|
||||
f"Programming Language :: Python :: 3.{i}"
|
||||
for i in range(8, version_range_max)
|
||||
],
|
||||
cmdclass={"deps_table_update": DepsTableUpdateCommand},
|
||||
)
|
||||
|
||||
|
||||
# Release checklist
|
||||
# 1. Change the version in __init__.py and setup.py.
|
||||
# 2. Commit these changes with the message: "Release: Release"
|
||||
# 3. Add a tag in git to mark the release: "git tag RELEASE -m 'Adds tag RELEASE for pypi' "
|
||||
# 3. Add a tag in git to mark the release: "git tag RELEASE -m 'Adds tag RELEASE for PyPI'"
|
||||
# Push the tag to git: git push --tags origin main
|
||||
# 4. Run the following commands in the top-level directory:
|
||||
# python setup.py bdist_wheel
|
||||
# python setup.py sdist
|
||||
# 5. Upload the package to the pypi test server first:
|
||||
# 5. Upload the package to the PyPI test server first:
|
||||
# twine upload dist/* -r pypitest
|
||||
# twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/
|
||||
# 6. Check that you can install it in a virtualenv by running:
|
||||
# pip install -i https://testpypi.python.org/pypi diffusers
|
||||
# diffusers env
|
||||
# diffusers test
|
||||
# 7. Upload the final version to actual pypi:
|
||||
# 7. Upload the final version to the actual PyPI:
|
||||
# twine upload dist/* -r pypi
|
||||
# 8. Add release notes to the tag in github once everything is looking hunky-dory.
|
||||
# 9. Update the version in __init__.py, setup.py to the new version "-dev" and push to master
|
||||
# 8. Add release notes to the tag in GitHub once everything is looking hunky-dory.
|
||||
# 9. Update the version in __init__.py, setup.py to the new version "-dev" and push to main.
|
||||
|
||||
Reference in New Issue
Block a user