-
Notifications
You must be signed in to change notification settings - Fork 239
/
setup.py
265 lines (236 loc) · 9.19 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
"""Setup for imitation: a reward and imitation learning library."""
import os
import warnings
from sys import platform
from typing import TYPE_CHECKING
from setuptools import find_packages, setup
from setuptools.command.install import install
if TYPE_CHECKING:
from setuptools_scm.version import ScmVersion
IS_NOT_WINDOWS = os.name != "nt"
PARALLEL_REQUIRE = ["ray[debug,tune]~=2.0.0"]
ATARI_REQUIRE = [
"seals[atari]~=0.2.1",
]
PYTYPE = ["pytype==2023.9.27"] if IS_NOT_WINDOWS else []
HYPOTHESIS = ["hypothesis~=6.54.1"]
# Note: the versions of the test and doc requirements should be tightly pinned to known
# working versions to make our CI/CD pipeline as stable as possible.
TESTS_REQUIRE = (
[
"black[jupyter]~=22.6.0",
"coverage~=6.4.2",
"codecov~=2.1.12",
"codespell~=2.1.0",
"darglint~=1.8.1",
"filelock~=3.7.1",
"flake8~=4.0.1",
"flake8-blind-except==0.2.1",
"flake8-builtins~=1.5.3",
"flake8-commas~=2.1.0",
"flake8-debugger~=4.1.2",
"flake8-docstrings~=1.6.0",
"flake8-isort~=4.1.2",
"ipykernel~=6.15.1",
"jupyter~=1.0.0",
# TODO: upgrade jupyter-client once
# https://github.com/jupyter/jupyter_client/issues/637 is fixed
"jupyter-client~=6.1.12",
"moviepy~=1.0.3",
"mypy~=0.990",
"pandas~=1.4.3",
"pytest~=7.1.2",
"pytest-cov~=3.0.0",
"pytest-notebook==0.8.0",
"pytest-timeout~=2.1.0",
"pytest-xdist~=2.5.0",
"scipy~=1.9.0",
"wandb==0.12.21",
"setuptools_scm~=7.0.5",
"pre-commit>=2.20.0",
]
+ PARALLEL_REQUIRE
+ ATARI_REQUIRE
+ PYTYPE
+ HYPOTHESIS
)
DOCS_REQUIRE = (
[
"sphinx~=5.1.1",
"sphinx-autodoc-typehints~=1.19.1",
"sphinx-rtd-theme~=1.0.0",
"sphinxcontrib-napoleon==0.7",
"furo==2022.6.21",
"sphinx-copybutton==0.5.0",
"sphinx-github-changelog~=1.2.0",
"myst-nb==0.17.2",
"ipykernel~=6.15.2",
]
+ ATARI_REQUIRE
+ PARALLEL_REQUIRE
+ HYPOTHESIS
)
def get_readme() -> str:
"""Retrieve content from README."""
with open("README.md", "r", encoding="utf-8") as f:
return f.read()
class InstallCommand(install):
"""Custom install command to throw warnings about external dependencies."""
def run(self):
"""Run the install command."""
install.run(self)
if platform == "darwin":
warnings.warn(
"Installation of important packages for macOS is required. "
"Scripts in the experiments folder will likely not run without these "
"packages: gnu-getopt, parallel, coreutils. They can be installed with "
"Homebrew by running `brew install gnu-getopt parallel coreutils`."
"See https://brew.sh/ for installation instructions.",
)
def get_version(version: "ScmVersion") -> str:
"""Generates the version string for the package.
This function replaces the default version format used by setuptools_scm
to allow development builds to be versioned using the git commit hash
instead of the number of commits since the last release, which leads to
duplicate version identifiers when using multiple branches
(see https://github.com/HumanCompatibleAI/imitation/issues/500).
The version has the following format:
{version}[.dev{build}]
where build is the shortened commit hash converted to base 10.
Args:
version: The version object given by setuptools_scm, calculated
from the git repository.
Returns:
The formatted version string to use for the package.
"""
# We import setuptools_scm here because it is only installed after the module
# is loaded and the setup function is called.
from setuptools_scm import version as scm_version
if version.node:
# By default node corresponds to the short commit hash when using git,
# plus a "g" prefix. We remove the "g" prefix from the commit hash which
# is added by setuptools_scm by default ("g" for git vs. mercurial etc.)
# because letters are not valid for version identifiers in PEP 440.
# We also convert from hexadecimal to base 10 for the same reason.
version.node = str(int(version.node.lstrip("g"), 16))
if version.exact:
# an exact version is when the current commit is tagged with a version.
return version.format_with("{tag}")
else:
# the current commit is not tagged with a version, so we guess
# what the "next" version will be (this can be disabled but is the
# default behavior of setuptools_scm so it has been left in).
return version.format_next_version(
scm_version.guess_next_version,
fmt="{guessed}.dev{node}",
)
def get_local_version(version: "ScmVersion", time_format="%Y%m%d") -> str:
"""Generates the local version string for the package.
By default, when commits are made on top of a release version, setuptools_scm
sets the version to be {version}.dev{distance}+{node} where {distance} is the number
of commits since the last release and {node} is the short commit hash.
This function replaces the default version format used by setuptools_scm
so that committed changes away from a release version are not considered
local versions but dev versions instead (by using the format
{version}.dev{node} instead. This is so that we can push test releases
to TestPyPI (it does not accept local versions).
Local versions are still present if there are uncommitted changes (if the tree
is dirty), in which case the current date is added to the version.
Args:
version: The version object given by setuptools_scm, calculated
from the git repository.
time_format: The format to use for the date.
Returns:
The formatted local version string to use for the package.
"""
return version.format_choice(
"",
"+d{time:{time_format}}",
time_format=time_format,
)
setup(
cmdclass={"install": InstallCommand},
name="imitation",
use_scm_version={"local_scheme": get_local_version, "version_scheme": get_version},
setup_requires=["setuptools_scm"],
description="Implementation of modern reward and imitation learning algorithms.",
long_description=get_readme(),
long_description_content_type="text/markdown",
author="Center for Human-Compatible AI and Google",
python_requires=">=3.8.0",
packages=find_packages("src"),
package_dir={"": "src"},
package_data={"imitation": ["py.typed", "scripts/config/tuned_hps/*.json"]},
# Note: while we are strict with our test and doc requirement versions, we try to
# impose as little restrictions on the install requirements as possible. Try to
# encode only known incompatibilities here. This prevents nasty dependency issues
# for our users.
install_requires=[
"gymnasium[classic-control]~=0.29",
"matplotlib",
"numpy>=1.15",
"torch>=1.4.0",
"tqdm",
"rich",
"scikit-learn>=0.21.2",
"seals~=0.2.1",
"stable-baselines3~=2.2.1",
"sacred>=0.8.4",
"tensorboard>=1.14",
"huggingface_sb3~=3.0",
"optuna>=3.0.1",
"datasets>=2.8.0",
],
tests_require=TESTS_REQUIRE,
extras_require={
# recommended packages for development
"dev": [
"autopep8",
"ipdb",
"isort~=5.0",
"codespell",
"sphinx-autobuild",
# for convenience
*TESTS_REQUIRE,
*DOCS_REQUIRE,
]
+ PYTYPE,
"test": TESTS_REQUIRE,
"docs": DOCS_REQUIRE,
"parallel": PARALLEL_REQUIRE,
"mujoco": [
"gymnasium[classic-control,mujoco]~=0.29",
],
"atari": ATARI_REQUIRE,
},
entry_points={
"console_scripts": [
"imitation-eval-policy=imitation.scripts.eval_policy:main_console",
"imitation-parallel=imitation.scripts.parallel:main_console",
(
"imitation-train-adversarial="
"imitation.scripts.train_adversarial:main_console"
),
"imitation-train-imitation=imitation.scripts.train_imitation:main_console",
(
"imitation-train-preference-comparisons="
"imitation.scripts.train_preference_comparisons:main_console"
),
"imitation-train-rl=imitation.scripts.train_rl:main_console",
],
},
url="https://github.com/HumanCompatibleAI/imitation",
license="MIT",
classifiers=[
# Trove classifiers
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
],
)