forked from unum-cloud/usearch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
214 lines (183 loc) · 7.64 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
import os
import sys
import subprocess
import platform
from setuptools import setup
from pybind11.setup_helpers import Pybind11Extension
sources = ["python/lib.cpp"]
compile_args = []
link_args = []
macros_args = []
def get_bool_env(name: str, preference: bool) -> bool:
return os.environ.get(name, "1" if preference else "0") == "1"
def get_bool_env_w_name(name: str, preference: bool) -> tuple:
return name, "1" if get_bool_env(name, preference) else "0"
# Check the environment variables
is_linux: bool = sys.platform == "linux"
is_macos: bool = sys.platform == "darwin"
is_windows: bool = sys.platform == "win32"
machine: str = platform.machine().lower()
is_gcc = False
if is_linux:
cxx = os.environ.get("CXX")
if cxx:
try:
command = "where" if os.name == "nt" else "which"
full_path = subprocess.check_output([command, cxx], text=True).strip()
compiler_name = os.path.basename(full_path)
is_gcc = ("g++" in compiler_name) and ("clang++" not in compiler_name)
except subprocess.CalledProcessError:
pass
prefer_simsimd: bool = True
prefer_fp16lib: bool = True
prefer_openmp: bool = is_linux and is_gcc
use_simsimd: bool = get_bool_env("USEARCH_USE_SIMSIMD", prefer_simsimd)
use_fp16lib: bool = get_bool_env("USEARCH_USE_FP16LIB", prefer_fp16lib)
use_openmp: bool = get_bool_env("USEARCH_USE_OPENMP", prefer_openmp)
# Common arguments for all platforms
macros_args.append(("USEARCH_USE_OPENMP", "1" if use_openmp else "0"))
macros_args.append(("USEARCH_USE_SIMSIMD", "1" if use_simsimd else "0"))
macros_args.append(("USEARCH_USE_FP16LIB", "1" if use_fp16lib else "0"))
if is_linux:
compile_args.append("-std=c++17")
compile_args.append("-O3") # Maximize performance
compile_args.append("-ffast-math") # Maximize floating-point performance
compile_args.append("-Wno-unknown-pragmas")
compile_args.append("-fdiagnostics-color=always")
# Simplify debugging, but the normal `-g` may make builds much longer!
compile_args.append("-g1")
if use_openmp:
compile_args.append("-fopenmp")
link_args.append("-lgomp")
if use_simsimd:
macros_args.extend(
[
get_bool_env_w_name("SIMSIMD_TARGET_NEON", True),
get_bool_env_w_name("SIMSIMD_TARGET_NEON_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_SVE", True),
get_bool_env_w_name("SIMSIMD_TARGET_SVE_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_HASWELL", True),
get_bool_env_w_name("SIMSIMD_TARGET_SKYLAKE", True),
get_bool_env_w_name("SIMSIMD_TARGET_ICE", True),
get_bool_env_w_name("SIMSIMD_TARGET_GENOA", True),
get_bool_env_w_name("SIMSIMD_TARGET_SAPPHIRE", True),
]
)
if is_macos:
# MacOS 10.15 or higher is needed for `aligned_alloc` support.
# https://github.com/unum-cloud/usearch/actions/runs/4975434891/jobs/8902603392
compile_args.append("-mmacosx-version-min=10.15")
compile_args.append("-std=c++17")
compile_args.append("-O3") # Maximize performance
compile_args.append("-ffast-math") # Maximize floating-point performance
compile_args.append("-fcolor-diagnostics")
compile_args.append("-Wno-unknown-pragmas")
# Simplify debugging, but the normal `-g` may make builds much longer!
compile_args.append("-g1")
# Linking OpenMP requires additional preparation in CIBuildWheel.
# We must install `brew install llvm` ahead of time.
# import subprocess as cli
# llvm_base = cli.check_output(["brew", "--prefix", "llvm"]).strip().decode("utf-8")
# if len(llvm_base):
# compile_args.append(f"-I{llvm_base}/include")
# compile_args.append("-Xpreprocessor -fopenmp")
# link_args.append(f"-L{llvm_base}/lib")
# link_args.append("-lomp")
# macros_args.append(("USEARCH_USE_OPENMP", "1"))
if use_simsimd:
macros_args.extend(
[
get_bool_env_w_name("SIMSIMD_TARGET_NEON", True),
get_bool_env_w_name("SIMSIMD_TARGET_NEON_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_SVE", False),
get_bool_env_w_name("SIMSIMD_TARGET_SVE_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_HASWELL", True),
get_bool_env_w_name("SIMSIMD_TARGET_SKYLAKE", False),
get_bool_env_w_name("SIMSIMD_TARGET_ICE", False),
get_bool_env_w_name("SIMSIMD_TARGET_GENOA", False),
get_bool_env_w_name("SIMSIMD_TARGET_SAPPHIRE", False),
]
)
if is_windows:
compile_args.append("/std:c++17")
compile_args.append("/O2")
compile_args.append("/fp:fast") # Enable fast math for MSVC
compile_args.append("/W1") # Reduce warnings verbosity
if use_simsimd:
macros_args.extend(
[
get_bool_env_w_name("SIMSIMD_TARGET_NEON", True),
get_bool_env_w_name("SIMSIMD_TARGET_NEON_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_SVE", False),
get_bool_env_w_name("SIMSIMD_TARGET_SVE_BF16", False),
get_bool_env_w_name("SIMSIMD_TARGET_HASWELL", True),
get_bool_env_w_name("SIMSIMD_TARGET_SKYLAKE", True),
get_bool_env_w_name("SIMSIMD_TARGET_ICE", True),
get_bool_env_w_name("SIMSIMD_TARGET_GENOA", False),
get_bool_env_w_name("SIMSIMD_TARGET_SAPPHIRE", False),
]
)
ext_modules = [
Pybind11Extension(
"usearch.compiled",
sources,
extra_compile_args=compile_args,
extra_link_args=link_args,
define_macros=macros_args,
),
]
__version__ = open("VERSION", "r").read().strip()
__lib_name__ = "usearch"
this_directory = os.path.abspath(os.path.dirname(__file__))
with open(os.path.join(this_directory, "README.md"), encoding="utf-8") as f:
long_description = f.read()
# Depending on the macros, adjust the include directories
include_dirs = [
"include",
"python",
"stringzilla/include",
]
if use_simsimd:
include_dirs.append("simsimd/include")
if use_fp16lib:
include_dirs.append("fp16/include")
setup(
name=__lib_name__,
version=__version__,
packages=["usearch"],
package_dir={"usearch": "python/usearch"},
description="Smaller & Faster Single-File Vector Search Engine from Unum",
author="Ash Vardanian",
author_email="info@unum.cloud",
url="https://github.com/unum-cloud/usearch",
long_description=long_description,
long_description_content_type="text/markdown",
license="Apache-2.0",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Natural Language :: English",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: C++",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Java",
"Programming Language :: JavaScript",
"Programming Language :: Objective C",
"Programming Language :: Rust",
"Programming Language :: Other",
"Operating System :: MacOS",
"Operating System :: Unix",
"Operating System :: Microsoft :: Windows",
"Topic :: System :: Clustering",
"Topic :: Database :: Database Engines/Servers",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
],
include_dirs=include_dirs,
ext_modules=ext_modules,
install_requires=[
"numpy",
"tqdm",
],
)