/
setup.py
312 lines (275 loc) · 12.4 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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# Copyright 2023-2024 Vincent Jacques
import glob
import itertools
import os
import setuptools
import setuptools.command.build_ext
import shutil
import subprocess
import sys
with open("lincs/__init__.py") as f:
for line in f.readlines():
if line.startswith("__version__ = "):
version = line[15:-2]
break
else:
assert False, "Version not found in lincs/__init__.py"
with open("README.rst") as f:
long_description = f.read()
for file in ["COPYING", "COPYING.LESSER"]:
long_description = long_description.replace(f" <{file}>`_", f" <https://github.com/MICS-Lab/lincs/blob/v{version}/{file}>`_")
for lang in ["yaml", "shell", "text", "diff"]:
long_description = long_description.replace(f".. highlight:: {lang}", "")
with open("requirements.txt") as f:
install_requires = f.readlines()
windows_cuda_path = os.environ.get("CUDA_PATH", r"C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.2")
# Method for building an extension with CUDA code extracted from https://stackoverflow.com/a/13300714/905845
# @todo(Project management, later) Consider using scikit-build:
# it should make it easier to compile CUDA code using nvcc and to run C++ unit tests during build.
# Note that pybind11 comes with an example of building using scikit-build.
# (see also https://www.benjack.io/hybrid-python/c-packages-revisited/)
def customize_compiler_for_nvcc(compiler):
compiler.src_extensions.append(".cu")
if compiler.compiler_type == "unix":
default_compile = compiler._compile
default_compiler_so = compiler.compiler_so
def _compile(obj, src, ext, cc_args, extra_postargs, pp_opts):
if os.path.splitext(src)[1] == ".cu":
compiler.set_executable("compiler_so", "nvcc")
postargs = extra_postargs["cuda"]
# Display number of GPU registered used (in case of 701=cudaErrorLaunchOutOfResources):
# postargs += ["-Xptxas", "-v"]
elif "vendored" in src:
postargs = extra_postargs["vendored-c++"]
else:
postargs = extra_postargs["c++"]
default_compile(obj, src, ext, cc_args, postargs, pp_opts)
compiler.compiler_so = default_compiler_so
compiler._compile = _compile
elif compiler.compiler_type == "msvc":
compiler._cpp_extensions += [".cu"]
compiler.initialize()
nvcc = os.path.join(windows_cuda_path, "bin", "nvcc")
default_compile = compiler.compile
default_spawn = compiler.spawn
default_cc = compiler.cc
def compile(
sources,
output_dir=None,
macros=None,
include_dirs=None,
debug=0,
extra_preargs=None,
extra_postargs=None,
depends=None,
):
cpp_sources = []
vendored_cpp_sources = []
cuda_sources = []
for src in sources:
if os.path.splitext(src)[1] == ".cu":
cuda_sources.append(src)
elif "vendored" in src:
vendored_cpp_sources.append(src)
else:
cpp_sources.append(src)
cpp_objects = default_compile(
cpp_sources,
output_dir=output_dir,
macros=macros,
include_dirs=include_dirs,
debug=debug,
extra_preargs=extra_preargs,
extra_postargs=extra_postargs["c++"],
depends=depends,
)
vendored_cpp_objects = default_compile(
vendored_cpp_sources,
output_dir=output_dir,
macros=macros,
include_dirs=include_dirs,
debug=debug,
extra_preargs=extra_preargs,
extra_postargs=extra_postargs["vendored-c++"],
depends=depends,
)
cuda_objects = []
if cuda_sources:
compiler.cc = nvcc
cuda_objects = default_compile(
cuda_sources,
output_dir=output_dir,
macros=macros,
include_dirs=include_dirs,
debug=debug,
extra_preargs=extra_preargs,
extra_postargs=extra_postargs["cuda"],
depends=depends,
)
compiler.cc = default_cc
return cpp_objects + vendored_cpp_objects + cuda_objects
def spawn(command):
if command[0] == nvcc:
patched_command = [nvcc]
xcompiler = False
for part in command[1:]:
if part == "-Xcompiler":
patched_command.append(part)
xcompiler = True
elif xcompiler:
patched_command.append(part)
xcompiler = False
elif part.startswith("-"):
patched_command.append(part)
elif part == "/c":
patched_command.append("-c")
elif part.startswith("/O"):
patched_command.append("-O" + part[2:])
elif part.startswith("/Tp"):
patched_command.append(part[3:])
elif part.startswith("/Fo"):
patched_command.append("-o")
patched_command.append(part[3:])
else:
print("WARNING: option passed by distutil to cl ignored when calling nvcc: " + part, file=sys.stderr)
default_spawn(patched_command)
else:
default_spawn(command)
compiler.compile = compile
compiler.spawn = spawn
else:
assert False, f"Unsupported compiler type: {compiler.compiler_type}"
class custom_build_ext(setuptools.command.build_ext.build_ext):
def build_extensions(self):
customize_compiler_for_nvcc(self.compiler)
setuptools.command.build_ext.build_ext.build_extensions(self)
def make_liblincs_extension():
define_macros = [("NDEBUG", None), ("DOCTEST_CONFIG_DISABLE", None)]
sources = []
sources += glob.glob(os.path.join("lincs", "liblincs", "**", "*.c"), recursive=True)
sources += glob.glob(os.path.join("lincs", "liblincs", "**", "*.cc"), recursive=True)
sources += glob.glob(os.path.join("lincs", "liblincs", "**", "*.cpp"), recursive=True)
# Non-standard: the dict is accessed in `customize_compiler_for_nvcc`
# to get the standard form for `extra_compile_args`
extra_compile_args = {}
libraries = []
include_dirs = []
library_dirs = []
extra_link_args=[]
if os.environ.get("LINCS_DEV_FORBID_NVCC", "false") != "true" and shutil.which("nvcc") is not None:
sources += glob.glob(os.path.join("lincs", "liblincs", "**", "*.cu"), recursive=True)
libraries += ["cudart"]
define_macros += [("LINCS_HAS_NVCC", None)]
# @todo(Project management, later) Support several versions of CUDA?
if sys.platform == "linux":
include_dirs += ["/usr/local/cuda-12.1/targets/x86_64-linux/include"]
library_dirs += ["/usr/local/cuda-12.1/targets/x86_64-linux/lib"]
extra_compile_args["cuda"] = ["-std=c++17", "-Xcompiler", "-fopenmp,-fPIC,-Werror=switch"]
elif sys.platform == "win32":
include_dirs += [os.path.join(windows_cuda_path, "include")]
library_dirs += [os.path.join(windows_cuda_path, r"lib\x64")]
extra_compile_args["cuda"] = ["-std=c++17", "-Xcompiler", "/openmp,/MD"]
else:
assert False, f"Unsupported platform for CUDA: {sys.platform}"
else:
if os.environ.get("LINCS_DEV_FORCE_NVCC", "false") == "true":
raise Exception("nvcc is not available but LINCS_DEV_FORCE_NVCC is true")
else:
print("WARNING: 'nvcc' was not found, lincs will be compiled without CUDA support", file=sys.stderr)
try:
chrones_dir = subprocess.run(
["chrones", "instrument", "c++", "header-location"], capture_output=True, universal_newlines=True, check=True
).stdout.strip()
except (subprocess.CalledProcessError, FileNotFoundError):
chrones_dir = None
if os.environ.get("LINCS_DEV_FORBID_CHRONES", "false") != "true" and chrones_dir is not None:
include_dirs += [chrones_dir]
define_macros += [("LINCS_HAS_CHRONES", None)]
else:
if os.environ.get("LINCS_DEV_FORCE_CHRONES", "false") == "true":
raise Exception("Chrones is not available but LINCS_DEV_FORCE_CHRONES is true")
else:
print("WARNING: 'chrones' was not found, lincs will be compiled without Chrones", file=sys.stderr)
if sys.platform == "linux":
extra_compile_args["c++"] = ["-std=c++17", "-Werror=switch", "-fopenmp"]
extra_compile_args["vendored-c++"] = ["-std=c++17", "-Werror=switch", "-w", "-DQUIET", "-DNBUILD", "-DNCONTRACTS"]
extra_link_args += ["-fopenmp"]
libraries += [
f"boost_python{sys.version_info.major}{sys.version_info.minor}",
"ortools",
# Weirdly required because of BoostPython:
f"python{sys.version_info.major}.{sys.version_info.minor}{'m' if sys.hexversion < 0x03080000 else ''}",
]
if os.environ.get("LINCS_DEV_COVERAGE", "false") == "true":
extra_compile_args["c++"] += ["--coverage", "-O0"]
extra_link_args += ["--coverage"]
elif sys.platform == "win32":
define_macros += [
("__WIN32", None), # For Cadical inside EvalMaxSat
("_SILENCE_ALL_CXX17_DEPRECATION_WARNINGS", None), # Silence a few warnings for OR-Tools
]
extra_compile_args["c++"] = ["/std:c++17", "/openmp"]
extra_compile_args["vendored-c++"] = ["/std:c++17", "-w", "-DQUIET", "-DNBUILD", "-DNCONTRACTS"]
lincs_dependencies = os.environ.get("LINCS_DEV_DEPENDENCIES", os.path.join("c:", "lincs-deps"))
include_dirs += [os.path.join(lincs_dependencies, "include")]
library_dirs += [os.path.join(lincs_dependencies, "lib")]
vc_version = os.environ.get("LINCS_DEV_VC_VERSION", "143")
libraries += [
f"boost_python{sys.version_info.major}{sys.version_info.minor}-vc{vc_version}-mt-x64-1_82",
"ortools",
f"python{sys.version_info.major}{sys.version_info.minor}",
]
elif sys.platform == "darwin":
extra_compile_args["c++"] = ["-std=c++17", "-Werror=switch", "-Xclang", "-fopenmp"]
extra_compile_args["vendored-c++"] = ["-std=c++17", "-Werror=switch", "-w", "-DQUIET", "-DNBUILD", "-DNCONTRACTS"]
extra_link_args += ["-lomp"]
libraries += [
f"boost_python{sys.version_info.major}{sys.version_info.minor}",
"ortools",
]
else:
assert False, f"Unsupported platform: {sys.platform}"
return setuptools.Extension(
name="liblincs",
sources=sources,
libraries=libraries,
define_macros=define_macros,
include_dirs=include_dirs,
library_dirs=library_dirs,
extra_compile_args=extra_compile_args,
extra_link_args=extra_link_args,
)
setuptools.setup(
name="lincs",
version=version,
description="Learn and Infer Non Compensatory Sortings",
license="LGPLv3",
long_description=long_description,
long_description_content_type="text/x-rst",
url="https://github.com/MICS-Lab/lincs",
author="Vincent Jacques",
author_email="vincent@vincent-jacques.net",
install_requires=install_requires,
packages=setuptools.find_packages(),
include_package_data=True,
entry_points={
"console_scripts": [
"lincs = lincs.command_line_interface:main",
],
},
ext_modules=[make_liblincs_extension()],
classifiers=[
"Development Status :: 2 - Pre-Alpha",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Operating System :: POSIX :: Linux",
"Programming Language :: C++",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
],
cmdclass={
"build_ext": custom_build_ext,
},
)