setup.py 9.43 KB
Newer Older
1
# Copyright 2022 The HuggingFace Team. All rights reserved.
Patrick von Platen's avatar
Patrick von Platen committed
2
3
4
5
6
7
8
9
10
11
12
13
14
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"""
Simple check list from AllenNLP repo: https://github.com/allenai/allennlp/blob/main/setup.py

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

3. Unpin specific versions from setup.py that use a git install.

4. Checkout the release branch (v<RELEASE>-release, for example v4.19-release), and commit these changes with the
Patrick von Platen's avatar
Patrick von Platen committed
31
   message: "Release: <RELEASE>" and push.
32
33
34

5. Wait for the tests on main to be completed and be green (otherwise revert and fix bugs)

Patrick von Platen's avatar
Patrick von Platen committed
35
6. Add a tag in git to mark the release: "git tag v<RELEASE> -m 'Adds tag v<RELEASE> for pypi' "
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
   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 sources, run: "python setup.py sdist"
   You should now have a /dist directory with both .whl and .tar.gz source versions.

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.)
   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/

   Check that you can install it in a virtualenv by running:
55
   pip install -i https://testpypi.python.org/pypi diffusers
56
57

   Check you can run the following commands:
58
59
   python -c "from diffusers import pipeline; classifier = pipeline('text-classification'); print(classifier('What a nice release'))"
   python -c "from diffusers import *"
60
61
62
63
64
65
66
67
68
69
70

9. Upload the final version to actual pypi:
   twine upload dist/* -r pypi

10. Copy the release notes from RELEASE.md to the tag in 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 re
71
import os
72
73
74
75
76
77
78
79
from distutils.core import Command

from setuptools import find_packages, setup

# IMPORTANT:
# 1. all dependencies should be listed here with their version requirements if any
# 2. once modified, run: `make deps_table_update` to update src/diffusers/dependency_versions_table.py
_deps = [
80
    "Pillow<10.0",  # keep the PIL.Image.Resampling deprecation away
Anton Lozhkov's avatar
Anton Lozhkov committed
81
    "accelerate>=0.11.0",
82
    "black==22.8",
Anton Lozhkov's avatar
Anton Lozhkov committed
83
    "datasets",
84
85
    "filelock",
    "flake8>=3.8.3",
86
    "flax>=0.4.1",
Anton Lozhkov's avatar
Anton Lozhkov committed
87
    "hf-doc-builder>=0.3.0",
88
    "huggingface-hub>=0.9.1",
Patrick von Platen's avatar
Patrick von Platen committed
89
    "importlib_metadata",
90
    "isort>=5.5.4",
91
92
    "jax>=0.2.8,!=0.3.2,<=0.3.6",
    "jaxlib>=0.1.65,<=0.3.6",
93
    "modelcards>=0.1.4",
94
    "numpy",
95
    "onnxruntime-gpu",
96
    "pytest",
97
98
    "pytest-timeout",
    "pytest-xdist",
99
    "scipy",
Patrick von Platen's avatar
Patrick von Platen committed
100
    "regex!=2019.12.17",
101
    "requests",
102
    "tensorboard",
Anton Lozhkov's avatar
Anton Lozhkov committed
103
    "torch>=1.4",
104
    "torchvision",
105
    "transformers>=4.21.0",
106
107
108
109
]

# this is a lookup table with items like:
#
110
# tokenizers: "huggingface-hub==0.8.0"
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# packaging: "packaging"
#
# some of the values are versioned whereas others aren't.
deps = {b: a for a, b in (re.findall(r"^(([^!=<>~]+)(?:[!=<>~].*)?$)", x)[0] for x in _deps)}

# since we save this data in src/diffusers/dependency_versions_table.py it can be easily accessed from
# 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
#
# Just pass the desired package names to that script as it's shown with 2 packages above.
#
# If diffusers is not yet installed and the work is done from the cloned repo remember to add `PYTHONPATH=src` to the script above
#
# 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)
#


def deps_list(*pkgs):
    return [deps[pkg] for pkg in pkgs]


class DepsTableUpdateCommand(Command):
    """
    A custom distutils command that updates the dependency table.
    usage: python setup.py deps_table_update
    """

    description = "build runtime dependency table"
    user_options = [
        # format: (long option, short option, description).
        ("dep-table-update", None, "updates src/diffusers/dependency_versions_table.py"),
    ]

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        entries = "\n".join([f'    "{k}": "{v}",' for k, v in deps.items()])
        content = [
            "# THIS FILE HAS BEEN AUTOGENERATED. To update:",
            "# 1. modify the `_deps` dict in setup.py",
            "# 2. run `make deps_table_update``",
            "deps = {",
            entries,
            "}",
            "",
        ]
        target = "src/diffusers/dependency_versions_table.py"
        print(f"updating {target}")
        with open(target, "w", encoding="utf-8", newline="\n") as f:
            f.write("\n".join(content))


extras = {}

Patrick von Platen's avatar
Patrick von Platen committed
174
175

extras = {}
176
177
178
179
180
181
182
183
184
185
186
187
188
extras["quality"] = deps_list("black", "isort", "flake8", "hf-doc-builder")
extras["docs"] = deps_list("hf-doc-builder")
extras["training"] = deps_list("accelerate", "datasets", "tensorboard", "modelcards")
extras["test"] = deps_list(
    "datasets",
    "onnxruntime-gpu",
    "pytest",
    "pytest-timeout",
    "pytest-xdist",
    "scipy",
    "torchvision",
    "transformers"
)
189
190
191
192
193
194
195
extras["torch"] = deps_list("torch")

if os.name == "nt":  # windows
    extras["flax"] = []  # jax is not supported on windows
else:
    extras["flax"] = deps_list("jax", "jaxlib", "flax")

196
197
198
extras["dev"] = (
    extras["quality"] + extras["test"] + extras["training"] + extras["docs"] + extras["torch"] + extras["flax"]
)
Patrick von Platen's avatar
Patrick von Platen committed
199

200
install_requires = [
Patrick von Platen's avatar
Patrick von Platen committed
201
    deps["importlib_metadata"],
202
203
204
    deps["filelock"],
    deps["huggingface-hub"],
    deps["numpy"],
Patrick von Platen's avatar
Patrick von Platen committed
205
    deps["regex"],
206
207
    deps["requests"],
    deps["Pillow"],
Patrick von Platen's avatar
Patrick von Platen committed
208
209
210
211
]

setup(
    name="diffusers",
212
    version="0.4.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)
Patrick von Platen's avatar
Patrick von Platen committed
213
214
215
216
217
218
219
220
221
222
    description="Diffusers",
    long_description=open("README.md", "r", encoding="utf-8").read(),
    long_description_content_type="text/markdown",
    keywords="deep learning",
    license="Apache",
    author="The HuggingFace team",
    author_email="patrick@huggingface.co",
    url="https://github.com/huggingface/diffusers",
    package_dir={"": "src"},
    packages=find_packages("src"),
223
    include_package_data=True,
224
    python_requires=">=3.7.0",
225
    install_requires=install_requires,
Patrick von Platen's avatar
Patrick von Platen committed
226
    extras_require=extras,
227
    entry_points={"console_scripts": ["diffusers-cli=diffusers.commands.diffusers_cli:main"]},
Patrick von Platen's avatar
Patrick von Platen committed
228
229
230
231
232
233
234
235
236
237
238
239
240
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "Intended Audience :: Education",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: Apache Software License",
        "Operating System :: OS Independent",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
    ],
241
    cmdclass={"deps_table_update": DepsTableUpdateCommand},
Patrick von Platen's avatar
Patrick von Platen committed
242
243
244
245
)

# Release checklist
# 1. Change the version in __init__.py and setup.py.
Patrick von Platen's avatar
Patrick von Platen committed
246
247
# 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' "
Patrick von Platen's avatar
Patrick von Platen committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
#    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:
#      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:
#      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