setup.py 6.85 KB
Newer Older
1
2
3
4
5
"""
Simple check list from AllenNLP repo: https://github.com/allenai/allennlp/blob/master/setup.py

To create the package for pypi.

6
7
8
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
9
   then run `make fix-copies` to fix the index of the documentation.
10

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

13
14
15
16
17
18
19
20
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
21
   For the wheel, run: "python setup.py bdist_wheel" in the top level directory.
22
   (this will build a wheel for the python version you use to build it).
23
24

   For the sources, run: "python setup.py sdist"
thomwolf's avatar
thomwolf committed
25
   You should now have a /dist directory with both .whl and .tar.gz source versions.
26
27
28
29
30

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
31
32
   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/
33
34

   Check that you can install it in a virtualenv by running:
35
   pip install -i https://testpypi.python.org/pypi transformers
36
37
38
39
40
41

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
42
8. Add the release version to docs/source/_static/js/custom.js and .circleci/deploy.sh
43
44

9. Update README.md to redirect to correct documentation.
45
"""
Aymeric Augustin's avatar
Aymeric Augustin committed
46

Stas Bekman's avatar
Stas Bekman committed
47
import os
48
49
50
import shutil
from pathlib import Path

thomwolf's avatar
thomwolf committed
51
52
from setuptools import find_packages, setup

53

54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# 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)


70
71
extras = {}

72
extras["ja"] = ["fugashi>=1.0", "ipadic>=1.0.0,<2.0", "unidic_lite>=1.0.7", "unidic>=1.0.2"]
73
extras["sklearn"] = ["scikit-learn"]
74
75
76

# keras2onnx and onnxconverter-common version is specific through a commit until 1.7.0 lands on pypi
extras["tf"] = [
sgugger's avatar
sgugger committed
77
    "tensorflow>=2.0",
Lysandre's avatar
Lysandre committed
78
79
80
81
    "onnxconverter-common",
    "keras2onnx"
    # "onnxconverter-common @ git+git://github.com/microsoft/onnxconverter-common.git@f64ca15989b6dc95a1f3507ff6e4c395ba12dff5#egg=onnxconverter-common",
    # "keras2onnx @ git+git://github.com/onnx/keras-onnx.git@cbdc75cb950b16db7f0a67be96a278f8d2953b48#egg=keras2onnx",
82
83
]
extras["tf-cpu"] = [
sgugger's avatar
sgugger committed
84
    "tensorflow-cpu>=2.0",
Lysandre's avatar
Lysandre committed
85
86
87
88
    "onnxconverter-common",
    "keras2onnx"
    # "onnxconverter-common @ git+git://github.com/microsoft/onnxconverter-common.git@f64ca15989b6dc95a1f3507ff6e4c395ba12dff5#egg=onnxconverter-common",
    # "keras2onnx @ git+git://github.com/onnx/keras-onnx.git@cbdc75cb950b16db7f0a67be96a278f8d2953b48#egg=keras2onnx",
89
]
sgugger's avatar
sgugger committed
90
extras["torch"] = ["torch>=1.0"]
Stas Bekman's avatar
Stas Bekman committed
91

92
extras["flax"] = ["jaxlib==0.1.55", "jax>=0.2.0", "flax==0.2.2"]
Stas Bekman's avatar
Stas Bekman committed
93
94
95
96
if os.name == "nt":  # windows
    extras["flax"] = [] # jax is not supported on windows

extras["tokenizers"] = ["tokenizers==0.9.2"]
97
extras["onnxruntime"] = ["onnxruntime>=1.4.0", "onnxruntime-tools>=1.4.2"]
98

99
extras["serving"] = ["pydantic", "uvicorn", "fastapi", "starlette"]
100

101
extras["sentencepiece"] = ["sentencepiece!=0.1.92"]
Ola Piktus's avatar
Ola Piktus committed
102
103
extras["retrieval"] = ["faiss-cpu", "datasets"]
extras["testing"] = ["pytest", "pytest-xdist", "timeout-decorator", "parameterized", "psutil"] + extras["retrieval"]
104
# sphinx-rtd-theme==0.5.0 introduced big changes in the style.
105
extras["docs"] = ["recommonmark", "sphinx", "sphinx-markdown-tables", "sphinx-rtd-theme==0.4.3", "sphinx-copybutton"]
Sylvain Gugger's avatar
Sylvain Gugger committed
106
extras["quality"] = ["black >= 20.8b1", "isort >= 5.5.4", "flake8 >= 3.8.3"]
Stas Bekman's avatar
Stas Bekman committed
107
108
109
110
111
112


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

extras["dev"] = extras["all"] + extras["testing"] + extras["quality"] + extras["ja"] + extras["docs"] + extras["sklearn"]

113

thomwolf's avatar
thomwolf committed
114
setup(
115
    name="transformers",
Lysandre's avatar
Lysandre committed
116
    version="3.4.0",
sgugger's avatar
sgugger committed
117
    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
118
    author_email="thomas@huggingface.co",
thomwolf's avatar
thomwolf committed
119
    description="State-of-the-art Natural Language Processing for TensorFlow 2.0 and PyTorch",
120
    long_description=open("README.md", "r", encoding="utf-8").read(),
thomwolf's avatar
thomwolf committed
121
    long_description_content_type="text/markdown",
122
123
    keywords="NLP deep learning transformer pytorch tensorflow BERT GPT GPT-2 google openai CMU",
    license="Apache",
124
    url="https://github.com/huggingface/transformers",
Aymeric Augustin's avatar
Aymeric Augustin committed
125
    package_dir={"": "src"},
126
    packages=find_packages("src"),
127
128
    install_requires=[
        "numpy",
129
        "tokenizers == 0.9.2",
130
131
        # dataclasses for Python versions that don't have it
        "dataclasses;python_version<'3.7'",
132
133
        # utilities from PyPA to e.g. compare versions
        "packaging",
Aymeric Augustin's avatar
Aymeric Augustin committed
134
        # filesystem locks e.g. to prevent parallel downloads
135
        "filelock",
Aymeric Augustin's avatar
Aymeric Augustin committed
136
        # for downloading models over HTTPS
137
        "requests",
Aymeric Augustin's avatar
Aymeric Augustin committed
138
        # progress bars in model download and training scripts
139
        "tqdm >= 4.27",
Aymeric Augustin's avatar
Aymeric Augustin committed
140
        # for OpenAI GPT
141
        "regex != 2019.12.17",
142
        # for SentencePiece models
143
        "sentencepiece != 0.1.92",
144
        "protobuf",
Aymeric Augustin's avatar
Aymeric Augustin committed
145
        # for XLM
146
        "sacremoses",
thomwolf's avatar
thomwolf committed
147
    ],
148
    extras_require=extras,
149
    entry_points={"console_scripts": ["transformers-cli=transformers.commands.transformers_cli:main"]},
150
    python_requires=">=3.6.0",
thomwolf's avatar
thomwolf committed
151
    classifiers=[
Aymeric Augustin's avatar
Aymeric Augustin committed
152
153
154
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "Intended Audience :: Education",
155
156
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: Apache Software License",
Aymeric Augustin's avatar
Aymeric Augustin committed
157
        "Operating System :: OS Independent",
158
        "Programming Language :: Python :: 3",
Aymeric Augustin's avatar
Aymeric Augustin committed
159
160
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
161
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
thomwolf's avatar
thomwolf committed
162
163
    ],
)