microsoft/onnxruntime-extensions

Public

mirrored fromhttps://github.com/microsoft/onnxruntime-extensionsAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
f9290e8bac2758dba8279d7ebc10e7027ffe0503

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

.pyproject/cmdclass.py

308lines · modecode

1# -*- coding: utf-8 -*-
2# Copyright (c) Microsoft Corporation. All rights reserved.
3# Licensed under the MIT License. See License.txt in the project root for
4# license information.
5###########################################################################
6
7import re
8import os
9import sys
10import pathlib
11import subprocess
12
13from textwrap import dedent
14from setuptools.command.build import build as _build
15from setuptools.command.build_ext import build_ext as _build_ext
16from setuptools.command.develop import develop as _develop
17
18VSINSTALLDIR_NAME = 'VSINSTALLDIR'
19ORTX_USER_OPTION = 'ortx-user-option'
20
21
22def _load_cuda_version():
23 nvcc_path = 'nvcc'
24 cuda_path = os.environ.get('CUDA_PATH')
25 if cuda_path is not None:
26 nvcc_path = os.path.join(cuda_path, 'bin', 'nvcc')
27 try:
28 output = subprocess.check_output([nvcc_path, "--version"], stderr=subprocess.STDOUT).decode("utf-8")
29 pattern = r"\bV(\d+\.\d+\.\d+)\b"
30 match = re.search(pattern, output)
31 if match:
32 return match.group(1)
33 except (subprocess.CalledProcessError, OSError):
34 pass
35
36 return None
37
38
39def _load_nvidia_smi():
40 try:
41 outputs = subprocess.check_output(
42 ["nvidia-smi", "--query-gpu=compute_cap", "--format=csv,noheader,nounits"],
43 stderr=subprocess.STDOUT).decode("utf-8").splitlines()
44 output = outputs[0] if outputs else ""
45 arch = output.strip().replace('.', '')
46 return arch if arch.isdigit() else None
47 except (subprocess.CalledProcessError, OSError):
48 pass
49
50 return None
51
52
53def _load_vsdevcmd(project_root):
54 if os.environ.get(VSINSTALLDIR_NAME) is None:
55 stdout, _ = subprocess.Popen([
56 'powershell', ' -noprofile', '-executionpolicy',
57 'bypass', '-f', project_root + '/tools/get_vsdevcmd.ps1', '-outputEnv', '1'],
58 stdout=subprocess.PIPE, shell=False, universal_newlines=True).communicate()
59 for line in stdout.splitlines():
60 kv_pair = line.split('=')
61 if len(kv_pair) == 2:
62 os.environ[kv_pair[0]] = kv_pair[1]
63 else:
64 import shutil
65 if shutil.which('cmake') is None:
66 raise SystemExit(
67 "Cannot find cmake in the executable path, "
68 "please run this script under Developer Command Prompt for VS.")
69
70
71def prepare_env(project_root):
72 if sys.platform == "win32":
73 _load_vsdevcmd(project_root)
74
75
76def read_git_refs(project_root):
77 release_branch = False
78 stdout, _ = subprocess.Popen(
79 ['git'] + ['log', '-1', '--format=%H'],
80 cwd=project_root,
81 stdout=subprocess.PIPE, universal_newlines=True).communicate()
82 HEAD = dedent(stdout.splitlines()[0]).strip('\n\r')
83 stdout, _ = subprocess.Popen(
84 ['git'] + ['show-ref', '--head'],
85 cwd=project_root,
86 stdout=subprocess.PIPE, universal_newlines=True).communicate()
87 for _ln in stdout.splitlines():
88 _ln = dedent(_ln).strip('\n\r')
89 if _ln.startswith(HEAD):
90 _, _2 = _ln.split(' ')
91 if _2.startswith('refs/remotes/origin/rel-'):
92 release_branch = True
93 return release_branch, HEAD
94
95
96class CommandMixin:
97 user_options = [
98 (ORTX_USER_OPTION + '=', None, "extensions options for kernel building")
99 ]
100 config_settings = None
101
102 # noinspection PyAttributeOutsideInit
103 def initialize_options(self) -> None:
104 super().initialize_options()
105 self.ortx_user_option = None
106
107 def finalize_options(self) -> None:
108 if self.ortx_user_option is not None:
109 if CommandMixin.config_settings is None:
110 CommandMixin.config_settings = {
111 ORTX_USER_OPTION: self.ortx_user_option}
112 else:
113 raise RuntimeError(
114 f"Cannot pass {ORTX_USER_OPTION} several times, like as the command args and in backend API.")
115
116 super().finalize_options()
117
118
119class CmdDevelop(CommandMixin, _develop):
120 user_options = getattr(_develop, 'user_options', []
121 ) + CommandMixin.user_options
122
123
124class CmdBuild(CommandMixin, _build):
125 user_options = getattr(_build, 'user_options', []) + \
126 CommandMixin.user_options
127
128 # noinspection PyAttributeOutsideInit
129 def finalize_options(self) -> None:
130 # There is a bug in setuptools that prevents the build get the right platform name from arguments.
131 # So, it cannot generate the correct wheel with the right arch in Official release pipeline.
132 # Force plat_name to be 'win-amd64' in Windows to fix that,
133 # since extensions cmake is only available on x64 for Windows now, it is not a problem to hardcode it.
134 if sys.platform == "win32" and "arm" not in sys.version.lower():
135 self.plat_name = "win-amd64"
136 if os.environ.get('OCOS_SCB_DEBUG', None) == '1':
137 self.debug = True
138 super().finalize_options()
139
140
141class CmdBuildCMakeExt(_build_ext):
142
143 # noinspection PyAttributeOutsideInit
144 def initialize_options(self):
145 super().initialize_options()
146 self.use_cuda = None
147 self.no_azure = None
148 self.no_opencv = None
149 self.cc_debug = None
150 self.cuda_archs = None
151
152 def _parse_options(self, options):
153 for segment in options.split(','):
154 if not segment:
155 continue
156 key = segment
157 if '=' in segment:
158 key, value = segment.split('=')
159 else:
160 value = 1
161
162 key = key.replace('-', '_')
163 if not hasattr(self, key):
164 raise RuntimeError(
165 f"Unknown {ORTX_USER_OPTION} option value: {key}")
166 setattr(self, key, value)
167 return self
168
169 def finalize_options(self) -> None:
170 if CommandMixin.config_settings is not None:
171 self._parse_options(
172 CommandMixin.config_settings.get(ORTX_USER_OPTION, ""))
173 if self.cc_debug:
174 self.debug = True
175 super().finalize_options()
176
177 def run(self):
178 """
179 Perform build_cmake before doing the 'normal' stuff
180 """
181 for extension in self.extensions:
182 if extension.name == 'onnxruntime_extensions._extensions_pydll':
183 self.build_cmake(extension)
184
185 def build_cmake(self, extension):
186 project_dir = pathlib.Path().absolute()
187 build_temp = pathlib.Path(self.build_temp)
188 build_temp.mkdir(parents=True, exist_ok=True)
189 ext_fullpath = pathlib.Path(
190 self.get_ext_fullpath(extension.name)).absolute()
191
192 config = 'RelWithDebInfo' if self.debug else 'Release'
193 cmake_args = [
194 '-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=' +
195 str(ext_fullpath.parent.absolute()),
196 '-DOCOS_ENABLE_CTEST=OFF',
197 '-DOCOS_BUILD_PYTHON=ON',
198 '-DOCOS_PYTHON_MODULE_PATH=' + str(ext_fullpath),
199 '-DCMAKE_BUILD_TYPE=' + config
200 ]
201
202 if self.no_opencv:
203 # Disabling openCV can drastically reduce the build time.
204 cmake_args += [
205 '-DOCOS_ENABLE_OPENCV_CODECS=OFF',
206 '-DOCOS_ENABLE_CV2=OFF',
207 '-DOCOS_ENABLE_VISION=OFF']
208
209 if self.no_azure is not None:
210 azure_flag = "OFF" if self.no_azure == 1 else "ON"
211 cmake_args += ['-DOCOS_ENABLE_AZURE=' + azure_flag]
212 print("=> AzureOp build flag: " + azure_flag)
213
214 if self.use_cuda is not None:
215 cuda_flag = "OFF" if self.use_cuda == 0 else "ON"
216 cmake_args += ['-DOCOS_USE_CUDA=' + cuda_flag]
217 print("=> CUDA build flag: " + cuda_flag)
218 if cuda_flag == "ON":
219 cuda_ver = _load_cuda_version()
220 if cuda_ver is None:
221 raise RuntimeError("Cannot find nvcc in your env:path, use-cuda doesn't work")
222 if sys.platform == "win32":
223 cuda_path = os.environ.get("CUDA_PATH")
224 cmake_args += [f'-T cuda={cuda_path}']
225 f_ver = ext_fullpath.parent / "_version.py"
226 with f_ver.open('a') as _f:
227 _f.writelines(["\n", f"cuda = \"{cuda_ver}\"", "\n"])
228
229 if self.cuda_archs is not None:
230 cmake_args += ['-DCMAKE_CUDA_ARCHITECTURES=' + self.cuda_archs]
231 else:
232 smi = _load_nvidia_smi()
233 if not smi:
234 raise RuntimeError(f"Cannot detect the CUDA archs from your machine, please specify it by yourself.")
235 cmake_args += ['-DCMAKE_CUDA_ARCHITECTURES=' + smi]
236
237 # CMake lets you override the generator - we need to check this.
238 # Can be set with Conda-Build, for example.
239 cmake_generator = os.environ.get("CMAKE_GENERATOR", "")
240 # Adding CMake arguments set as environment variable
241 # (needed e.g. to build for ARM OSx on conda-forge)
242 if "CMAKE_ARGS" in os.environ:
243 cmake_args += [
244 item for item in os.environ["CMAKE_ARGS"].split(" ") if item]
245
246 if sys.platform != "win32":
247 # Using Ninja-build since it a) is available as a wheel and b)
248 # multithread automatically. MSVC would require all variables be
249 # exported for Ninja to pick it up, which is a little tricky to do.
250 # Users can override the generator with CMAKE_GENERATOR in CMake
251 # 3.15+.
252 if not cmake_generator or cmake_generator == "Ninja":
253 try:
254 import ninja # noqa: F401
255
256 ninja_executable_path = os.path.join(
257 ninja.BIN_DIR, "ninja")
258 cmake_args += [
259 "-GNinja",
260 f"-DCMAKE_MAKE_PROGRAM:FILEPATH={ninja_executable_path}",
261 ]
262 except ImportError:
263 pass
264
265 if sys.platform.startswith("darwin"):
266 cmake_args += ["-DCMAKE_OSX_DEPLOYMENT_TARGET=10.15"]
267 # Cross-compile support for macOS - respect ARCHFLAGS if set
268 archs = re.findall(r"-arch (\S+)", os.environ.get("ARCHFLAGS", ""))
269 if archs:
270 cmake_args += [
271 "-DCMAKE_OSX_ARCHITECTURES={}".format(";".join(archs))]
272
273
274 # overwrite the Python module info if the auto-detection doesn't work.
275 # export Python3_INCLUDE_DIRS=/opt/python/cp38-cp38
276 # export Python3_LIBRARIES=/opt/python/cp38-cp38
277 for env in ['Python3_INCLUDE_DIRS', 'Python3_LIBRARIES']:
278 if env in os.environ:
279 cmake_args.append("-D%s=%s" % (env, os.environ[env]))
280
281 if self.debug:
282 cmake_args += ['-DCC_OPTIMIZE=OFF']
283
284 # the parallel build has to be limited on some Linux VM machine.
285 cpu_number = os.environ.get('CPU_NUMBER')
286 build_args = [
287 '--config', config,
288 '--parallel' + ('' if cpu_number is None else ' ' + cpu_number)
289 ]
290 cmake_exe = 'cmake'
291 # unlike Linux/macOS, cmake pip package on Windows fails to build some 3rd party dependencies.
292 # so we have to use the cmake installed from Visual Studio.
293 if os.environ.get(VSINSTALLDIR_NAME):
294 cmake_exe = os.environ[VSINSTALLDIR_NAME] + \
295 'Common7\\IDE\\CommonExtensions\\Microsoft\\CMake\\CMake\\bin\\cmake.exe'
296 # Add this cmake directory into PATH to make sure the child-process still find it.
297 os.environ['PATH'] = os.path.dirname(
298 cmake_exe) + os.pathsep + os.environ['PATH']
299
300 self.spawn([cmake_exe, '-S', str(project_dir),
301 '-B', str(build_temp)] + cmake_args)
302 if not self.dry_run:
303 self.spawn([cmake_exe, '--build', str(build_temp)] + build_args)
304
305
306ortx_cmdclass = dict(build=CmdBuild,
307 develop=CmdDevelop,
308 build_ext=CmdBuildCMakeExt)
309