forked from intel/intel-extension-for-pytorch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
926 lines (754 loc) · 32.7 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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
# This Python file uses the following encoding: utf-8
# !/usr/bin/env python
# Welcome to the Intel Extension for PyTorch setup.py.
#
# Environment variables you are probably interested in:
#
# DEBUG
# build with -O0 and -g (debug symbols)
#
# RELEASE
# build with optimization level -O2
#
# REL_WITH_DEB_INFO
# build with optimization level -O2 and -g (debug symbols)
#
# CFLAGS
# flags to apply to both C and C++ files to be compiled (a quirk of setup.py
# which we have faithfully adhered to in our build system is that CFLAGS
# also applies to C++ files (unless CXXFLAGS is set), in contrast to the
# default behavior of autogoo and cmake build systems.)
#
# CC
# the C/C++ compiler to use
#
# MKLROOT
# specify MKL library path.
# ONLY NEEDED if you have a specific MKL version you want to link against.
# Make sure this directory contains include and lib directories.
# By default, the MKL library installed with pip/conda is used.
#
# Environment variables we respect (these environment variables are
# conventional and are often understood/set by other software.)
#
# TORCH_VERSION
# specify the PyTorch version to depend on
#
# IPEX_VERSION
# specify the extension version literal
#
# MAX_JOBS
# process for parallel compile, must be a Integer
#
# VERBOSE
# more output when compile
#
# IPEX_VERSIONED_BUILD
# build wheel files versioned with a git commit number
#
##############################################################
# XPU Build options:
# USE_ONEMKL - to use oneMKL in operators
# USE_CHANNELS_LAST_1D - to use channels last 1d feature
# USE_PERSIST_STREAM - to use persistent oneDNN stream
# USE_PRIMITIVE_CACHE - to Cache oneDNN primitives by framework
# USE_QUEUE_BARRIER - to use queue submit_barrier API
# USE_SCRATCHPAD_MODE - to trun on oneDNN scratchpad user mode
# USE_MULTI_CONTEXT - to create DPC++ runtime context per device
# USE_AOT_DEVLIST - to set device list for AOT build option, for example, bdw,tgl,ats,..."
# USE_SYCL_ASSERT - to enable assert in sycl kernel
# USE_ITT_ANNOTATION - to enable ITT annotation in sycl kernel
# BUILD_STATIC_ONEMKL - to link static oneMKL libraries
# BUILD_STATS - to count statistics for each component during build process
# BUILD_BY_PER_KERNEL - to build by DPC++ per_kernel option (exclusive with USE_AOT_DEVLIST)
# BUILD_STRIPPED_BIN - to strip all symbols after build
# BUILD_SEPARATE_OPS - to build each operator in separate library
# BUILD_SIMPLE_TRACE - to build simple trace for each registered operator
# BUILD_OPT_LEVEL - to add build option -Ox, accept values: 0/1
# BUILD_NO_CLANGFORMAT - to build without force clang-format
# BUILD_INTERNAL_DEBUG - to build internal debug code path
#
##############################################################
from __future__ import print_function
from distutils.command.build_py import build_py
from distutils.command.install import install
from distutils.version import LooseVersion
from functools import lru_cache
from subprocess import check_call, check_output
from setuptools.command.build_clib import build_clib
from setuptools.command.egg_info import egg_info
from setuptools import setup, distutils
from pathlib import Path
from typing import Any, Optional
import sysconfig
import distutils.ccompiler
import distutils.command.clean
import os
import glob
import platform
import shutil
import subprocess
import sys
import errno
# FIXME: always set BUILD_WITH_XPU = ON in XPU repo
os.environ["BUILD_WITH_XPU"] = "OFF"
# Define env values
ON_ENV_VAL = ['ON', 'YES', '1', 'Y']
OFF_ENV_VAL = ['OFF', 'NO', '0', 'N']
FULL_ENV_VAL = ON_ENV_VAL + OFF_ENV_VAL
# initialize variables for compilation
IS_LINUX = (platform.system() == 'Linux')
IS_DARWIN = (platform.system() == 'Darwin')
IS_WINDOWS = (platform.system() == 'Windows')
@lru_cache(maxsize = 128)
def _get_build_target():
build_target = ''
if len(sys.argv) > 1:
if sys.argv[1] in ['build_clib', 'bdist_cppsdk']:
build_target = 'cppsdk'
elif sys.argv[1] in ['clean']:
build_target = 'clean'
else:
build_target = 'python'
return build_target
torch_install_prefix = None
if _get_build_target() == 'cppsdk':
torch_install_prefix = os.environ.get('LIBTORCH_PATH', None)
if torch_install_prefix is None or not os.path.exists(torch_install_prefix):
raise RuntimeError("Can not find libtorch from env LIBTORCH_PATH!")
torch_install_prefix = os.path.abspath(torch_install_prefix)
elif _get_build_target() == 'python':
try:
import torch
from torch.utils.cpp_extension import BuildExtension, CppExtension
except ImportError as e:
raise RuntimeError("Fail to import torch!")
def _check_env_flag(name, default=''):
return os.getenv(name, default).upper() in ON_ENV_VAL
def get_build_type():
return 'RelWithDebInfo' if _check_env_flag('REL_WITH_DEB_INFO') else 'Debug' if _check_env_flag('DEBUG') else 'Release'
def create_if_not_exist(path_dir):
if not os.path.exists(path_dir):
try:
Path(path_dir).mkdir(parents=True, exist_ok=True)
except OSError as exc: # Guard against race condition
if exc.errno != errno.EEXIST:
raise RuntimeError("Fail to create path {}".format(path_dir))
def get_version_num():
versions = {}
version_file = 'version.txt'
version_lines = open(version_file, 'r').readlines()
for line in version_lines:
key, value = line.strip().split(' ')
versions[key] = value
for v in ('VERSION_MAJOR', 'VERSION_MINOR', 'VERSION_PATCH'):
if v not in versions:
print("ERROR:", v, "is not found in", version_file)
sys.exit(1)
version = versions['VERSION_MAJOR'] + '.' + versions['VERSION_MINOR'] + '.' + versions['VERSION_PATCH']
return version
PACKAGE_NAME = "intel_extension_for_pytorch"
PYTHON_VERSION = sys.version_info
def get_pytorch_install_dir():
if _get_build_target() == 'clean':
return None
if _get_build_target() == 'cppsdk':
return torch_install_prefix
else:
return os.path.dirname(os.path.abspath(torch.__file__))
pytorch_install_dir = get_pytorch_install_dir()
def _build_installation_dependency():
install_requires = []
install_requires.append('psutil')
install_requires.append('numpy')
return install_requires
def which(thefile: str) -> Optional[str]:
path = os.environ.get("PATH", os.defpath).split(os.pathsep)
for d in path:
fname = os.path.join(d, thefile)
fnames = [fname]
if sys.platform == "win32":
exts = os.environ.get("PATHEXT", "").split(os.pathsep)
fnames += [fname + ext for ext in exts]
for name in fnames:
if os.access(name, os.F_OK | os.X_OK) and not os.path.isdir(name):
return name
return None
def get_cmake_command():
if platform.system() == 'Windows':
return 'cmake'
def _get_version(cmd: Optional[str]) -> Any:
"Returns cmake version."
if cmd is None:
return None
for line in check_output([cmd, "--version"]).decode("utf-8").split("\n"):
if "version" in line:
return LooseVersion(line.strip().split(" ")[2])
raise RuntimeError("no version found")
cmake3_version = _get_version(which("cmake3"))
cmake_version = _get_version(which("cmake"))
_cmake_min_version = LooseVersion("3.13.0")
if all(
(
ver is None or ver < _cmake_min_version
for ver in [cmake_version, cmake3_version]
)
):
raise RuntimeError("Require cmake or cmake3 3.13.0 or higher but not found")
if cmake3_version is None:
cmake_command = "cmake"
elif cmake_version is None:
cmake_command = "cmake3"
else:
if cmake3_version >= cmake_version:
cmake_command = "cmake3"
else:
cmake_command = "cmake"
return cmake_command
def get_cpack_command():
if platform.system() == 'Windows':
return 'cpack'
if shutil.which('cpack3') is not None:
return 'cpack3'
if shutil.which('cpack') is not None:
return 'cpack'
else:
raise RuntimeError('no cpack or cpack3 found')
def get_ipex_git_head_sha(base_dir):
ipex_git_sha = subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD'], cwd=base_dir).decode('ascii').strip()
return ipex_git_sha
def get_torch_git_head_sha():
if _get_build_target() == 'clean':
return None
if _get_build_target() == 'cppsdk':
libtorch_hash_file = os.path.join(torch_install_prefix, 'build-hash')
if not os.path.exists(libtorch_hash_file):
raise RuntimeError('can not find build-hash at {}'.format(libtorch_hash_file))
with open(libtorch_hash_file, 'r') as f:
lines = f.readlines()
for line in lines:
line = line.strip()
if line.isalnum():
return line
raise RuntimeError('can not get libtorch hash in {}'.format(libtorch_hash_file))
else:
torch_git_sha = torch.version.git_version
return torch_git_sha
def get_submodule_commit(base_dir, submodule_dir):
if not os.path.isdir(submodule_dir):
return ''
return subprocess.check_output(
['git', 'submodule', 'status', submodule_dir], cwd=base_dir).decode('ascii').strip().split()[0]
def get_build_version(ipex_git_sha):
pkg_type = 'xpu' if _check_env_flag('BUILD_WITH_XPU') else 'cpu'
ipex_version = os.getenv('IPEX_VERSION', get_version_num())
if _check_env_flag('IPEX_VERSIONED_BUILD', default='1'):
try:
ipex_version += '+git' + ipex_git_sha[:7]
except Exception:
pass
else:
ipex_version += '+' + pkg_type
return ipex_version
def write_buffer_to_file(file_path, buffer):
create_if_not_exist(os.path.dirname(file_path))
with open(file_path, 'w') as f:
f.write(buffer)
f.close()
def get_code_fingerprint(ipex_build_version, ipex_git_sha, torch_git_sha, build_type):
fingerprint = "{}_{}_{}_{}".format(ipex_build_version, ipex_git_sha, torch_git_sha, build_type)
return fingerprint
def check_code_fingerprint_in_file(file_path, fingerprint):
b_exist = os.path.isfile(file_path)
if b_exist is False:
return False
with open(file_path) as file:
# read all content of a file
content = file.read()
# check if string present in a file
if fingerprint in content:
return True
else:
return False
def create_version_files(base_dir, ipex_build_version, ipex_git_sha, torch_git_sha, gpu_onednn_sha, cpu_ideep_sha):
print('Building Intel Extension for PyTorch. Version: {}'.format(ipex_build_version))
py_version_path = os.path.join(base_dir, PACKAGE_NAME, '_version.py')
cpp_version_path = os.path.join(base_dir, PACKAGE_NAME, '..', 'csrc', 'utils', 'version.h')
build_type_str = get_build_type()
# Check code fingerprint to avoid non-modify rebuild.
current_code_fingerprint = get_code_fingerprint(ipex_build_version, ipex_git_sha, torch_git_sha, build_type_str)
b_same_fingerprint = check_code_fingerprint_in_file(py_version_path, current_code_fingerprint)
if b_same_fingerprint is False:
py_buffer = "# Autogenerated file, do not edit!\n"
py_buffer += "# code fingerprint:\n"
py_buffer += "# {}\n\n".format(current_code_fingerprint)
py_buffer += "__version__ = \"{}\"\n".format(ipex_build_version)
py_buffer += "__ipex_gitrev__ = \"{}\"\n".format(ipex_git_sha)
py_buffer += "__torch_gitrev__ = \"{}\"\n".format('' if build_type_str == 'Release' else torch_git_sha)
py_buffer += "__gpu_onednn_gitrev__ = \"{}\"\n".format(gpu_onednn_sha)
py_buffer += "__cpu_ideep_gitrev__ = \"{}\"\n".format(cpu_ideep_sha)
py_buffer += "__build_type__ = \"{}\"\n".format(build_type_str)
write_buffer_to_file(py_version_path, py_buffer)
b_same_fingerprint = check_code_fingerprint_in_file(cpp_version_path, current_code_fingerprint)
if b_same_fingerprint is False:
c_buffer = '// Autogenerated file, do not edit!\n'
c_buffer += '// clang-format off\n'
c_buffer += '// code fingerprint: {}\n'.format(current_code_fingerprint)
c_buffer += '// clang-format on\n\n'
c_buffer += '#pragma once\n'
c_buffer += '#include <string>\n\n'
c_buffer += 'namespace torch_ipex {\n\n'
c_buffer += 'const std::string __version__()\n'
c_buffer += '{{ return "{}"; }}\n\n'.format(ipex_build_version)
c_buffer += 'const std::string __gitrev__()\n'
c_buffer += '{{ return "{}"; }}\n\n'.format(ipex_git_sha)
c_buffer += 'const std::string __torch_gitrev__()\n'
c_buffer += '{{ return "{}"; }}\n\n'.format(torch_git_sha)
c_buffer += 'const std::string __build_type__()\n'
c_buffer += '{{ return "{}"; }}\n\n'.format(build_type_str)
c_buffer += '} // namespace torch_ipex\n'
write_buffer_to_file(cpp_version_path, c_buffer)
def get_project_dir():
project_root_dir = os.path.dirname(__file__)
return os.path.abspath(project_root_dir)
def get_build_dir():
return os.path.join(get_project_dir(), 'build')
def get_build_type_dir():
build_type_dir = os.path.join(get_build_dir(), get_build_type())
create_if_not_exist(build_type_dir)
return build_type_dir
def get_package_base_dir():
return os.path.join(get_build_type_dir(), "packages")
def get_package_dir():
return os.path.join(get_package_base_dir(), PACKAGE_NAME)
def get_package_lib_dir():
package_lib_dir = os.path.join(get_package_dir(), "lib")
create_if_not_exist(package_lib_dir)
return package_lib_dir
def get_ipex_cpu_dir():
cpu_root_dir = os.path.join(get_project_dir(), 'csrc', 'cpu')
return os.path.abspath(cpu_root_dir)
def get_ipex_cpu_build_dir():
cpu_build_dir = os.path.join(get_build_type_dir(), 'csrc', 'cpu')
create_if_not_exist(cpu_build_dir)
return cpu_build_dir
def get_xpu_project_dir():
project_root_dir = os.path.abspath(os.path.dirname(__file__))
return os.path.join(project_root_dir)
def get_xpu_project_build_dir():
xpu_build_dir = os.path.join(get_build_type_dir(), 'csrc', 'gpu')
create_if_not_exist(xpu_build_dir)
return xpu_build_dir
def get_xpu_compliers():
if shutil.which('icx') is None or shutil.which('icpx') is None:
raise RuntimeError("Failed to find compiler path from OS PATH")
return "icx", "icpx"
def get_ipex_python_dir():
project_root_dir = os.path.dirname(__file__)
python_root_dir = os.path.join(project_root_dir, PACKAGE_NAME, 'csrc')
return os.path.abspath(python_root_dir)
def get_ipex_python_build_dir():
python_build_dir = os.path.join(get_build_type_dir(), PACKAGE_NAME, 'csrc')
create_if_not_exist(python_build_dir)
return python_build_dir
def get_ipex_cppsdk_build_dir():
cppsdk_build_dir = os.path.join(get_build_type_dir(), 'csrc', 'cppsdk')
create_if_not_exist(cppsdk_build_dir)
return cppsdk_build_dir
base_dir = os.path.dirname(os.path.abspath(__file__))
# Generate version info (ipex.__version__)
torch_git_sha = get_torch_git_head_sha()
ipex_git_sha = get_ipex_git_head_sha(base_dir)
ipex_build_version = get_build_version(ipex_git_sha)
ipex_gpu_onednn_git_sha = get_submodule_commit(base_dir, "third_party/oneDNN")
ipex_cpu_ideep_git_sha = get_submodule_commit(base_dir, "third_party/ideep")
create_version_files(base_dir, ipex_build_version, ipex_git_sha, torch_git_sha,
ipex_gpu_onednn_git_sha, ipex_cpu_ideep_git_sha)
# global setup modules
class IPEXClean(distutils.command.clean.clean, object):
def run(self):
import glob
import re
with open('.gitignore', 'r') as f:
ignores = f.read()
pat = re.compile(r'^#( BEGIN NOT-CLEAN-FILES )?')
for wildcard in filter(None, ignores.split('\n')):
match = pat.match(wildcard)
if match:
if match.group(1):
# Marker is found and stop reading .gitignore.
break
# Ignore lines which begin with '#'.
else:
for filename in glob.glob(wildcard):
try:
os.remove(filename)
except OSError:
shutil.rmtree(filename, ignore_errors=True)
# It's an old-style class in Python 2.7...
distutils.command.clean.clean.run(self)
def get_cpp_test_dir():
project_root_dir = os.path.abspath(os.path.dirname(__file__))
return os.path.join(project_root_dir, 'tests', 'cpu', 'cpp')
def get_cpp_test_build_dir():
cpp_test_build_dir = os.path.join(get_build_type_dir(), 'tests', 'cpu', 'cpp')
create_if_not_exist(cpp_test_build_dir)
return cpp_test_build_dir
def get_pybind11_abi_compiler_flags():
pybind11_abi_flags = []
for pname in ["COMPILER_TYPE", "STDLIB", "BUILD_ABI"]:
pval = getattr(torch._C, f"_PYBIND11_{pname}")
if pval is not None:
pybind11_abi_flags.append(f'-DPYBIND11_{pname}=\\"{pval}\\"')
cl_flags = ""
for flag in pybind11_abi_flags:
cl_flags += (flag + ' ')
return cl_flags
def _gen_build_cfg_from_cmake(cmake_exec, project_root_dir, cmake_args, build_dir, build_env):
check_call([cmake_exec, project_root_dir] + cmake_args, cwd=build_dir, env=build_env)
def _build_project(build_args, build_dir, build_env, use_ninja = False):
if use_ninja:
check_call(['ninja'] + build_args, cwd=build_dir, env=build_env)
else:
check_call(['make'] + build_args, cwd=build_dir, env=build_env)
def define_build_options(args, **kwargs):
for key, value in sorted(kwargs.items()):
if value is not None:
args.append('-D{}={}'.format(key, value))
class IPEXCPPLibBuild(build_clib, object):
def run(self):
self.build_lib = os.path.relpath(get_package_dir())
self.build_temp = os.path.relpath(get_build_type_dir())
cmake_exec = get_cmake_command()
if cmake_exec is None:
raise RuntimeError(
"CMake must be installed to build the following extensions: " +
", ".join(e.name for e in self.extensions))
self.cmake = cmake_exec
if platform.system() == "Windows":
raise RuntimeError("Intel Extension for PyTorch only supports Linux now.")
project_root_dir = get_project_dir()
build_type_dir = get_build_type_dir()
output_lib_path = get_package_lib_dir()
ipex_python_dir = get_ipex_python_dir()
ipex_python_build_dir = get_ipex_python_build_dir()
ipex_cpu_dir = get_ipex_cpu_dir()
ipex_cpu_build_dir = get_ipex_cpu_build_dir()
ipex_xpu_dir = get_xpu_project_dir()
ipex_xpu_build_dir = get_xpu_project_build_dir()
ipex_cppsdk_build_dir = get_ipex_cppsdk_build_dir()
cpack_out_file = os.path.abspath(os.path.join(build_type_dir, 'IPEXCPackConfig.cmake'))
self_extract_script = "gen_self_extract.sh"
if _get_build_target() == 'cppsdk':
cmake_prefix_path = torch_install_prefix
else:
cmake_prefix_path = torch.utils.cmake_prefix_path
build_option_common = {
'CMAKE_BUILD_TYPE' : get_build_type(),
'CMAKE_INSTALL_LIBDIR' : 'lib',
'CMAKE_PREFIX_PATH' : cmake_prefix_path,
'CMAKE_INSTALL_PREFIX' : os.path.abspath(get_package_dir()),
'IPEX_INSTALL_LIBDIR' : os.path.abspath(output_lib_path),
'CMAKE_PROJECT_VERSION' : get_version_num(),
'PYTHON_PLATFORM_INFO' : platform.platform(),
'PYTHON_INCLUDE_DIR' : sysconfig.get_paths()['include'],
'PYTHON_EXECUTABLE' : sys.executable,
'IPEX_PROJ_NAME' : PACKAGE_NAME,
'LIBIPEX_GITREV' : ipex_git_sha,
'LIBIPEX_VERSION' : ipex_build_version,
}
build_with_cpu = True # Default ON
build_with_xpu = False # Default OFF
use_ninja = False
sequential_build = False
cmake_common_args = []
my_env = os.environ.copy()
for var, val in my_env.items():
if var.startswith(('BUILD_', 'USE_', 'CMAKE_')):
if var == 'CMAKE_PREFIX_PATH':
# XXX: Do NOT overwrite CMAKE_PREFIX_PATH. Append into the list, instead!
build_option_common[var] = ';'.join([build_option_common[var], val.replace(':', ';')])
continue
if var == 'USE_NINJA' and val.upper() in ON_ENV_VAL:
use_ninja = True
cmake_common_args.append('-GNinja')
continue
if var == 'BUILD_STATS' and val.upper() in ON_ENV_VAL:
sequential_build = True
# fall through
if var == 'BUILD_WITH_XPU' and val.upper() in ON_ENV_VAL:
build_with_xpu = True
# fall through
if var == 'BUILD_WITH_CPU' and val.upper() in OFF_ENV_VAL:
build_with_cpu = False
# fall through
build_option_common[var] = val
define_build_options(cmake_common_args, **build_option_common)
nproc = min(int(os.environ.get('MAX_JOBS', os.cpu_count())), os.cpu_count())
if sequential_build:
nproc = 1
print("WARNING: Practice as sequential build with single process !")
build_args = ['-j', str(nproc), 'install']
if _check_env_flag('VERBOSE') and use_ninja:
build_args.append('-v')
if build_with_xpu:
# Generate cmake for XPU module:
if os.path.isdir(ipex_xpu_dir) is False:
raise RuntimeError('It maybe CPU only branch, and it is not contains XPU code.')
gpu_cc, gpu_cxx = get_xpu_compliers()
build_option_gpu = {
**build_option_common,
'BUILD_MODULE_TYPE' : 'GPU',
'CMAKE_C_COMPILER' : gpu_cc,
'CMAKE_CXX_COMPILER' : gpu_cxx
}
if get_build_type() == 'Debug':
build_option_gpu = {
**build_option_gpu,
'BUILD_SEPARATE_OPS' : 'ON',
'USE_SYCL_ASSERT' : 'ON',
'USE_ITT_ANNOTATION' : 'ON'
}
cmake_args_gpu = []
define_build_options(cmake_args_gpu, **build_option_gpu)
_gen_build_cfg_from_cmake(cmake_exec, project_root_dir, cmake_args_gpu, ipex_xpu_build_dir, my_env)
if build_with_cpu:
# Generate cmake for CPU module:
build_option_cpu = {
**build_option_common,
'BUILD_MODULE_TYPE' : 'CPU'
}
cmake_args_cpu = []
define_build_options(cmake_args_cpu, **build_option_cpu)
_gen_build_cfg_from_cmake(cmake_exec, project_root_dir, cmake_args_cpu, ipex_cpu_build_dir, my_env)
# Generate cmake for the CPP UT
build_option_cpp_test = {
**build_option_common,
'PROJECT_DIR' : project_root_dir,
'PYTORCH_INSTALL_DIR' : pytorch_install_dir,
'CPP_TEST_BUILD_DIR' : get_cpp_test_build_dir(),
}
cmake_args_cpp_test = []
define_build_options(cmake_args_cpp_test, **build_option_cpp_test)
_gen_build_cfg_from_cmake(cmake_exec, get_cpp_test_dir(), cmake_args_cpp_test, get_cpp_test_build_dir(), my_env)
if _get_build_target() == 'python':
# Generate cmake for common python module:
build_option_python = {
**build_option_common,
'BUILD_MODULE_TYPE' : 'PYTHON',
'PYBIND11_CL_FLAGS' : get_pybind11_abi_compiler_flags(),
}
cmake_args_python = []
define_build_options(cmake_args_python, **build_option_python)
_gen_build_cfg_from_cmake(cmake_exec, project_root_dir, cmake_args_python, ipex_python_build_dir, my_env)
elif _get_build_target() == 'cppsdk':
# Generate cmake for CPPSDK package:
build_option_cppsdk = {
**build_option_common,
'BUILD_MODULE_TYPE' : 'CPPSDK',
'CPACK_CONFIG_FILE' : cpack_out_file,
'CPACK_OUTPUT_DIR' : build_type_dir,
'LIBIPEX_GEN_SCRIPT': self_extract_script
}
cmake_args_cppsdk = []
define_build_options(cmake_args_cppsdk, **build_option_cppsdk)
_gen_build_cfg_from_cmake(cmake_exec, project_root_dir, cmake_args_cppsdk, ipex_cppsdk_build_dir, my_env)
if build_with_xpu:
# Build XPU module:
_build_project(build_args, ipex_xpu_build_dir, my_env, use_ninja)
if build_with_cpu:
# Build CPU module:
_build_project(build_args, ipex_cpu_build_dir, my_env, use_ninja)
# Build the CPP UT
_build_project(build_args, get_cpp_test_build_dir(), my_env, use_ninja)
if _get_build_target() == 'python':
# Build common python module:
_build_project(build_args, ipex_python_build_dir, my_env, use_ninja)
elif _get_build_target() == 'cppsdk':
# Build CPPSDK package:
_build_project(build_args, ipex_cppsdk_build_dir, my_env, use_ninja)
cpack_exec = get_cpack_command()
check_call([cpack_exec, '--config', cpack_out_file])
gen_script_path = os.path.abspath(os.path.join(build_type_dir, self_extract_script))
if not os.path.isfile(gen_script_path):
raise "Cannot find script to generate self-extract package in {}".format(gen_script_path)
check_call(gen_script_path, shell=True)
def get_src_py_and_dst():
ret = []
generated_python_files = glob.glob(
os.path.join(get_project_dir(), PACKAGE_NAME, '**/*.py'),
recursive=True)
for src in generated_python_files:
dst = os.path.join(
get_package_base_dir(),
PACKAGE_NAME,
os.path.relpath(src, os.path.join(get_project_dir(), PACKAGE_NAME)))
dst_path = Path(dst)
if not dst_path.parent.exists():
Path(dst_path.parent).mkdir(parents=True, exist_ok=True)
ret.append((src, dst))
return ret
# python specific setup modules
class IPEXEggInfoBuild(egg_info, object):
def finalize_options(self):
self.egg_base = os.path.relpath(get_package_base_dir())
ret = get_src_py_and_dst()
for src, dst in ret:
self.copy_file(src, dst)
super(IPEXEggInfoBuild, self).finalize_options()
class IPEXInstallCmd(install, object):
def finalize_options(self) -> None:
self.build_lib = os.path.relpath(get_package_base_dir())
return super(IPEXInstallCmd, self).finalize_options()
class IPEXPythonPackageBuild(build_py, object):
def run(self) -> None:
ret = get_src_py_and_dst()
for src, dst in ret:
self.copy_file(src, dst)
super(IPEXPythonPackageBuild, self).finalize_options()
def make_relative_rpath(path):
if IS_DARWIN:
return '-Wl,-rpath,@loader_path/' + path
elif IS_WINDOWS:
raise "Windows support is in the plan. Intel Extension for PyTorch supports Linux now."
else:
return '-Wl,-rpath,$ORIGIN/' + path
def pyi_module():
main_libraries = ['intel-ext-pt-python']
main_sources = [os.path.join(PACKAGE_NAME, "csrc", "_C.cpp")]
include_dirs = [
os.path.realpath("."),
os.path.realpath(os.path.join(PACKAGE_NAME, "csrc")),
os.path.join(pytorch_install_dir, "include"),
os.path.join(pytorch_install_dir, "include", "torch", "csrc", "api", "include")]
library_dirs = [
"lib",
os.path.join(pytorch_install_dir, "lib")
]
extra_compile_args = [
'-Wall',
'-Wextra',
'-Wno-strict-overflow',
'-Wno-unused-parameter',
'-Wno-missing-field-initializers',
'-Wno-write-strings',
'-Wno-unknown-pragmas',
# This is required for Python 2 declarations that are deprecated in 3.
'-Wno-deprecated-declarations',
# Python 2.6 requires -fno-strict-aliasing, see
# http://legacy.python.org/dev/peps/pep-3123/
# We also depend on it in our code (even Python 3).
'-fno-strict-aliasing',
# Clang has an unfixed bug leading to spurious missing
# braces warnings, see
# https://bugs.llvm.org/show_bug.cgi?id=21629
'-Wno-missing-braces']
C_ext = CppExtension(
"{}._C".format(PACKAGE_NAME),
libraries=main_libraries,
sources=main_sources,
language='c++',
extra_compile_args=extra_compile_args,
include_dirs=include_dirs,
library_dirs=library_dirs,
extra_link_args=[make_relative_rpath('lib')])
return C_ext
def pyi_isa_help_module():
main_libraries = []
main_sources = [os.path.join(PACKAGE_NAME, "csrc", "_isa_help_main.cpp"),
os.path.join(PACKAGE_NAME, "csrc", "cpu", "isa_help", "isa_help.cpp"),
os.path.join("csrc", "cpu", "isa", "cpu_feature.cpp")]
include_dirs = [
os.path.realpath("."),
os.path.realpath(os.path.join("csrc", "cpu", "isa")),
os.path.realpath(os.path.join(PACKAGE_NAME, "csrc")),
os.path.join(pytorch_install_dir, "include"),
os.path.join(pytorch_install_dir, "include", "torch", "csrc", "api", "include")]
library_dirs = [
"lib",
os.path.join(pytorch_install_dir, "lib")
]
extra_compile_args = [
'-Wall',
'-Wextra',
'-Wno-strict-overflow',
'-Wno-unused-parameter',
'-Wno-missing-field-initializers',
'-Wno-write-strings',
'-Wno-unknown-pragmas',
# This is required for Python 2 declarations that are deprecated in 3.
'-Wno-deprecated-declarations',
# Python 2.6 requires -fno-strict-aliasing, see
# http://legacy.python.org/dev/peps/pep-3123/
# We also depend on it in our code (even Python 3).
'-fno-strict-aliasing',
# Clang has an unfixed bug leading to spurious missing
# braces warnings, see
# https://bugs.llvm.org/show_bug.cgi?id=21629
'-Wno-missing-braces']
C_ext = CppExtension(
"{}._isa_help".format(PACKAGE_NAME),
libraries=main_libraries,
sources=main_sources,
language='c++',
extra_compile_args=extra_compile_args,
include_dirs=include_dirs,
library_dirs=library_dirs,
extra_link_args=[make_relative_rpath('lib')])
return C_ext
ext_modules = []
cmdclass = {
'build_clib' : IPEXCPPLibBuild,
'bdist_cppsdk': IPEXCPPLibBuild,
'clean': IPEXClean,
}
def fill_python_target_cmd(cmdclass, ext_modules):
class IPEXExtBuild(BuildExtension):
def run(self):
self.run_command('build_clib')
self.build_lib = os.path.relpath(get_package_base_dir())
self.build_temp = os.path.relpath(get_build_type_dir())
self.library_dirs.append(os.path.relpath(get_package_lib_dir()))
super(IPEXExtBuild, self).run()
cmdclass['build_ext'] = IPEXExtBuild
cmdclass['build_py'] = IPEXPythonPackageBuild
cmdclass['egg_info'] = IPEXEggInfoBuild
cmdclass['install'] = IPEXInstallCmd
ext_modules.append(pyi_module())
ext_modules.append(pyi_isa_help_module())
if _get_build_target() == 'python':
fill_python_target_cmd(cmdclass, ext_modules)
long_description = ''
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()
entry_points = {
'console_scripts': [
'ipexrun = {}.cpu.launch.__main__:main'.format(PACKAGE_NAME),
]
}
setup(
name=PACKAGE_NAME,
version=ipex_build_version,
description='Intel® Extension for PyTorch*',
long_description=long_description,
long_description_content_type='text/markdown',
url='https://github.com/intel/intel-extension-for-pytorch',
author='Intel Corp.',
install_requires=_build_installation_dependency(),
packages=[PACKAGE_NAME],
package_data={
PACKAGE_NAME: [
"*.so",
"lib/*.so",
]},
package_dir={'': os.path.relpath(get_package_base_dir())},
zip_safe=False,
ext_modules=ext_modules,
cmdclass=cmdclass,
entry_points=entry_points,
license='https://www.apache.org/licenses/LICENSE-2.0',
classifiers=[
'License :: OSI Approved :: Apache Software License',
],
)