setup.py 10.2 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Copyright 2020 The HuggingFace Team. All rights reserved.
#
# 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
"""
Simple check list from AllenNLP repo: https://github.com/allenai/allennlp/blob/master/setup.py

To create the package for pypi.

20
21
22
1. Change the version in __init__.py, setup.py as well as docs/source/conf.py. Remove the master from the links in
   the new models of the README:
   (https://huggingface.co/transformers/master/model_doc/ -> https://huggingface.co/transformers/model_doc/)
sgugger's avatar
sgugger committed
23
   then run `make fix-copies` to fix the index of the documentation.
24

Sylvain Gugger's avatar
Sylvain Gugger committed
25
2. Unpin specific versions from setup.py that use a git install.
Lysandre's avatar
Lysandre committed
26

27
28
29
30
31
32
33
34
2. Commit these changes with the message: "Release: VERSION"

3. Add a tag in git to mark the release: "git tag VERSION -m'Adds tag VERSION for pypi' "
   Push the tag to git: git push --tags origin master

4. Build both the sources and the wheel. Do not change anything in setup.py between
   creating the wheel and the source distribution (obviously).

thomwolf's avatar
thomwolf committed
35
   For the wheel, run: "python setup.py bdist_wheel" in the top level directory.
36
   (this will build a wheel for the python version you use to build it).
37
38

   For the sources, run: "python setup.py sdist"
thomwolf's avatar
thomwolf committed
39
   You should now have a /dist directory with both .whl and .tar.gz source versions.
40
41
42
43
44

5. 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.)
Lysandre's avatar
Lysandre committed
45
46
   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/
47
48

   Check that you can install it in a virtualenv by running:
49
   pip install -i https://testpypi.python.org/pypi transformers
50
51
52
53
54
55

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

7. Copy the release notes from RELEASE.md to the tag in github once everything is looking hunky-dory.

Lysandre's avatar
Lysandre committed
56
8. Add the release version to docs/source/_static/js/custom.js and .circleci/deploy.sh
57
58

9. Update README.md to redirect to correct documentation.
59
60

10. Update the version in __init__.py, setup.py to the new version "-dev" and push to master.
61
"""
Aymeric Augustin's avatar
Aymeric Augustin committed
62

Stas Bekman's avatar
Stas Bekman committed
63
import os
64
import re
65
import shutil
66
from distutils.core import Command
67
68
from pathlib import Path

thomwolf's avatar
thomwolf committed
69
70
from setuptools import find_packages, setup

71

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Remove stale transformers.egg-info directory to avoid https://github.com/pypa/pip/issues/5466
stale_egg_info = Path(__file__).parent / "transformers.egg-info"
if stale_egg_info.exists():
    print(
        (
            "Warning: {} exists.\n\n"
            "If you recently updated transformers to 3.0 or later, this is expected,\n"
            "but it may prevent transformers from installing in editable mode.\n\n"
            "This directory is automatically generated by Python's packaging tools.\n"
            "I will remove it now.\n\n"
            "See https://github.com/pypa/pip/issues/5466 for details.\n"
        ).format(stale_egg_info)
    )
    shutil.rmtree(stale_egg_info)


88
89
90
91
92
93
94
95
96
97
98
99
# 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/transformers/dependency_versions_table.py
_deps = [
    "black>=20.8b1",
    "cookiecutter==1.7.2",
    "dataclasses",
    "datasets",
    "faiss-cpu",
    "fastapi",
    "filelock",
    "flake8>=3.8.3",
100
    "flax>=0.2.2",
101
    "fugashi>=1.0",
102
    "importlib_metadata",
103
104
105
106
107
108
    "ipadic>=1.0.0,<2.0",
    "isort>=5.5.4",
    "jax>=0.2.0",
    "jaxlib==0.1.55",
    "keras2onnx",
    "numpy",
Lysandre's avatar
Lysandre committed
109
    "onnxconverter-common",
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
    "onnxruntime-tools>=1.4.2",
    "onnxruntime>=1.4.0",
    "packaging",
    "parameterized",
    "protobuf",
    "psutil",
    "pydantic",
    "pytest",
    "pytest-xdist",
    "python>=3.6.0",
    "recommonmark",
    "regex!=2019.12.17",
    "requests",
    "sacremoses",
    "scikit-learn",
    "sentencepiece==0.1.91",
    "sphinx-copybutton",
    "sphinx-markdown-tables",
    "sphinx-rtd-theme==0.4.3",  # sphinx-rtd-theme==0.5.0 introduced big changes in the style.
    "sphinx==3.2.1",
    "starlette",
131
132
    "tensorflow-cpu>=2.3",
    "tensorflow>=2.3",
133
134
135
136
137
138
139
    "timeout-decorator",
    "tokenizers==0.9.4",
    "torch>=1.0",
    "tqdm>=4.27",
    "unidic>=1.0.2",
    "unidic_lite>=1.0.7",
    "uvicorn",
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
174
175
176
177
178


# tokenizers: "tokenizers==0.9.4" lookup table
# support non-versions file too so that they can be checked at run time
deps = {b: a for a, b in (re.findall(r"^(([^!=<>]+)(?:[!=<>].*)?$)", x)[0] for x in _deps)}


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/transformers/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,
            "}",
179
            "",
180
181
182
        ]
        target = "src/transformers/dependency_versions_table.py"
        print(f"updating {target}")
Julien Plu's avatar
Julien Plu committed
183
        with open(target, "w", encoding="utf-8", newline="\n") as f:
184
185
186
187
188
189
190
191
192
193
194
195
            f.write("\n".join(content))


extras = {}

extras["ja"] = deps_list("fugashi", "ipadic", "unidic_lite", "unidic")
extras["sklearn"] = deps_list("scikit-learn")

extras["tf"] = deps_list("tensorflow", "onnxconverter-common", "keras2onnx")
extras["tf-cpu"] = deps_list("tensorflow-cpu", "onnxconverter-common", "keras2onnx")

extras["torch"] = deps_list("torch")
Stas Bekman's avatar
Stas Bekman committed
196
197

if os.name == "nt":  # windows
198
199
    extras["retrieval"] = deps_list("datasets")  # faiss is not supported on windows
    extras["flax"] = []  # jax is not supported on windows
200
else:
201
202
    extras["retrieval"] = deps_list("faiss-cpu", "datasets")
    extras["flax"] = deps_list("jax", "jaxlib", "flax")
203

204
205
206
extras["tokenizers"] = deps_list("tokenizers")
extras["onnxruntime"] = deps_list("onnxruntime", "onnxruntime-tools")
extras["modelcreation"] = deps_list("cookiecutter")
207

208
extras["serving"] = deps_list("pydantic", "uvicorn", "fastapi", "starlette")
Stas Bekman's avatar
Stas Bekman committed
209

210
211
212
213
214
215
216
217
218
extras["sentencepiece"] = deps_list("sentencepiece", "protobuf")
extras["retrieval"] = deps_list("faiss-cpu", "datasets")
extras["testing"] = (
    deps_list("pytest", "pytest-xdist", "timeout-decorator", "parameterized", "psutil")
    + extras["retrieval"]
    + extras["modelcreation"]
)
extras["docs"] = deps_list("recommonmark", "sphinx", "sphinx-markdown-tables", "sphinx-rtd-theme", "sphinx-copybutton")
extras["quality"] = deps_list("black", "isort", "flake8")
Stas Bekman's avatar
Stas Bekman committed
219
220
221

extras["all"] = extras["tf"] + extras["torch"] + extras["flax"] + extras["sentencepiece"] + extras["tokenizers"]

222
223
224
225
226
227
228
229
230
extras["dev"] = (
    extras["all"]
    + extras["testing"]
    + extras["quality"]
    + extras["ja"]
    + extras["docs"]
    + extras["sklearn"]
    + extras["modelcreation"]
)
Stas Bekman's avatar
Stas Bekman committed
231

232
233
extras["torchhub"] = deps_list("filelock", "importlib_metadata", "numpy", "packaging", "protobuf", "regex",
                               "requests", "sacremoses", "sentencepiece", "torch", "tokenizers", "tqdm")
234

235
236
237
# when modifying the following list, make sure to update src/transformers/dependency_versions_check.py
install_requires = [
    deps["dataclasses"] + ";python_version<'3.7'",  # dataclasses for Python versions that don't have it
238
    deps["importlib_metadata"] + ";python_version<'3.8'",  # importlib_metadata for Python versions that don't have it
239
    deps["filelock"],  # filesystem locks, e.g., to prevent parallel downloads
240
241
    deps["numpy"],
    deps["packaging"],  # utilities from PyPA to e.g., compare versions
242
243
244
    deps["regex"],  # for OpenAI GPT
    deps["requests"],  # for downloading models over HTTPS
    deps["sacremoses"],  # for XLM
Sylvain Gugger's avatar
Sylvain Gugger committed
245
    deps["tokenizers"],
246
    deps["tqdm"],  # progress bars in model download and training scripts
247
248
]

thomwolf's avatar
thomwolf committed
249
setup(
250
    name="transformers",
251
    version="4.2.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)
sgugger's avatar
sgugger committed
252
    author="Thomas Wolf, Lysandre Debut, Victor Sanh, Julien Chaumond, Sam Shleifer, Patrick von Platen, Sylvain Gugger, Google AI Language Team Authors, Open AI team Authors, Facebook AI Authors, Carnegie Mellon University Authors",
thomwolf's avatar
thomwolf committed
253
    author_email="thomas@huggingface.co",
thomwolf's avatar
thomwolf committed
254
    description="State-of-the-art Natural Language Processing for TensorFlow 2.0 and PyTorch",
255
    long_description=open("README.md", "r", encoding="utf-8").read(),
thomwolf's avatar
thomwolf committed
256
    long_description_content_type="text/markdown",
257
258
    keywords="NLP deep learning transformer pytorch tensorflow BERT GPT GPT-2 google openai CMU",
    license="Apache",
259
    url="https://github.com/huggingface/transformers",
Aymeric Augustin's avatar
Aymeric Augustin committed
260
    package_dir={"": "src"},
261
    packages=find_packages("src"),
262
    extras_require=extras,
263
    entry_points={"console_scripts": ["transformers-cli=transformers.commands.transformers_cli:main"]},
264
    python_requires=">=3.6.0",
265
    install_requires=install_requires,
thomwolf's avatar
thomwolf committed
266
    classifiers=[
Aymeric Augustin's avatar
Aymeric Augustin committed
267
268
269
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "Intended Audience :: Education",
270
271
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: Apache Software License",
Aymeric Augustin's avatar
Aymeric Augustin committed
272
        "Operating System :: OS Independent",
273
        "Programming Language :: Python :: 3",
Aymeric Augustin's avatar
Aymeric Augustin committed
274
275
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
276
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
thomwolf's avatar
thomwolf committed
277
    ],
278
    cmdclass={"deps_table_update": DepsTableUpdateCommand},
thomwolf's avatar
thomwolf committed
279
)