setup.py 13.1 KB
Newer Older
1
# ******************************************************************************
2
# Copyright 2017-2019 Intel Corporation
3 4 5 6 7 8 9 10 11 12 13 14 15 16
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ******************************************************************************

17
from setuptools import setup, Extension
18 19 20 21 22 23
from setuptools.command.build_ext import build_ext
import sys
import setuptools
import os
import distutils.ccompiler

24
__version__ = os.environ.get('NGRAPH_VERSION', '0.0.0-dev')
aslepko's avatar
aslepko committed
25
PYNGRAPH_ROOT_DIR = os.path.abspath(os.path.dirname(__file__))
26
NGRAPH_DEFAULT_INSTALL_DIR = os.environ.get('HOME')
27
NGRAPH_ONNX_IMPORT_ENABLE = os.environ.get('NGRAPH_ONNX_IMPORT_ENABLE')
28

29 30 31 32 33 34

def find_ngraph_dist_dir():
    """Return location of compiled ngraph library home."""
    if os.environ.get('NGRAPH_CPP_BUILD_PATH'):
        ngraph_dist_dir = os.environ.get('NGRAPH_CPP_BUILD_PATH')
    else:
35
        ngraph_dist_dir = os.path.join(NGRAPH_DEFAULT_INSTALL_DIR, 'ngraph_dist')
36 37 38

    found = os.path.exists(os.path.join(ngraph_dist_dir, 'include/ngraph'))
    if not found:
39 40
        print('Cannot find nGraph library in {} make sure that '
              'NGRAPH_CPP_BUILD_PATH is set correctly'.format(ngraph_dist_dir))
41 42
        sys.exit(1)
    else:
43
        print('nGraph library found in {}'.format(ngraph_dist_dir))
44 45 46 47
        return ngraph_dist_dir


def find_pybind_headers_dir():
48
    """Return location of pybind11 headers."""
49 50 51
    if os.environ.get('PYBIND_HEADERS_PATH'):
        pybind_headers_dir = os.environ.get('PYBIND_HEADERS_PATH')
    else:
aslepko's avatar
aslepko committed
52
        pybind_headers_dir = os.path.join(PYNGRAPH_ROOT_DIR, 'pybind11')
53 54 55

    found = os.path.exists(os.path.join(pybind_headers_dir, 'include/pybind11'))
    if not found:
56 57
        print('Cannot find pybind11 library in {} make sure that '
              'PYBIND_HEADERS_PATH is set correctly'.format(pybind_headers_dir))
58 59
        sys.exit(1)
    else:
60
        print('pybind11 library found in {}'.format(pybind_headers_dir))
61 62 63 64
        return pybind_headers_dir


NGRAPH_CPP_DIST_DIR = find_ngraph_dist_dir()
65 66
PYBIND11_INCLUDE_DIR = find_pybind_headers_dir() + '/include'
NGRAPH_CPP_INCLUDE_DIR = NGRAPH_CPP_DIST_DIR + '/include'
67 68 69 70 71 72 73 74
if os.path.exists(NGRAPH_CPP_DIST_DIR + '/lib'):
    NGRAPH_CPP_LIBRARY_DIR = NGRAPH_CPP_DIST_DIR + '/lib'
elif os.path.exists(NGRAPH_CPP_DIST_DIR + '/lib64'):
    NGRAPH_CPP_LIBRARY_DIR = NGRAPH_CPP_DIST_DIR + '/lib64'
else:
    print('Cannot find library directory in {}, make sure that nGraph is installed '
          'correctly'.format(NGRAPH_CPP_DIST_DIR))
    sys.exit(1)
75 76


77 78 79 80 81 82 83 84 85 86 87
def parallelCCompile(
    self,
    sources,
    output_dir=None,
    macros=None,
    include_dirs=None,
    debug=0,
    extra_preargs=None,
    extra_postargs=None,
    depends=None,
):
88 89 90 91 92 93
    """Build sources in parallel.

    Reference link:
    http://stackoverflow.com/questions/11013851/speeding-up-build-process-with-distutils
    Monkey-patch for parallel compilation.
    """
94 95
    # those lines are copied from distutils.ccompiler.CCompiler directly
    macros, objects, extra_postargs, pp_opts, build = self._setup_compile(
96
        output_dir, macros, include_dirs, sources, depends, extra_postargs)
97 98 99 100 101 102 103 104 105 106
    cc_args = self._get_cc_args(pp_opts, debug, extra_preargs)
    # parallel code
    import multiprocessing.pool

    def _single_compile(obj):
        try:
            src, ext = build[obj]
        except KeyError:
            return
        self._compile(obj, src, ext, cc_args, extra_postargs, pp_opts)
107

108
    # convert to list, imap is evaluated on-demand
109 110
    pool = multiprocessing.pool.ThreadPool()
    list(pool.imap(_single_compile, objects))
111 112 113
    return objects


114
distutils.ccompiler.CCompiler.compile = parallelCCompile
115 116 117


def has_flag(compiler, flagname):
118 119 120 121
    """Check whether a flag is supported by the specified compiler.

    As of Python 3.6, CCompiler has a `has_flag` method.
    cf http://bugs.python.org/issue26689
122
    """
123
    import tempfile
124

125 126 127 128 129 130 131 132 133 134
    with tempfile.NamedTemporaryFile('w', suffix='.cpp') as f:
        f.write('int main (int argc, char **argv) { return 0; }')
        try:
            compiler.compile([f.name], extra_postargs=[flagname])
        except setuptools.distutils.errors.CompileError:
            return False
    return True


def cpp_flag(compiler):
135
    """Check and return the -std=c++11 compiler flag."""
136
    if has_flag(compiler, '-std=c++11'):
137 138
        return '-std=c++11'
    else:
139
        raise RuntimeError('Unsupported compiler -- C++11 support is needed!')
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


sources = [
    'pyngraph/function.cpp',
    'pyngraph/serializer.cpp',
    'pyngraph/node.cpp',
    'pyngraph/shape.cpp',
    'pyngraph/strides.cpp',
    'pyngraph/coordinate_diff.cpp',
    'pyngraph/axis_set.cpp',
    'pyngraph/axis_vector.cpp',
    'pyngraph/coordinate.cpp',
    'pyngraph/pyngraph.cpp',
    'pyngraph/util.cpp',
    'pyngraph/ops/util/arithmetic_reduction.cpp',
    'pyngraph/ops/util/binary_elementwise_comparison.cpp',
    'pyngraph/ops/util/op_annotations.cpp',
    'pyngraph/ops/util/binary_elementwise_arithmetic.cpp',
    'pyngraph/ops/util/binary_elementwise_logical.cpp',
    'pyngraph/ops/util/regmodule_pyngraph_op_util.cpp',
    'pyngraph/ops/util/unary_elementwise_arithmetic.cpp',
    'pyngraph/ops/util/index_reduction.cpp',
    'pyngraph/ops/abs.cpp',
    'pyngraph/ops/acos.cpp',
    'pyngraph/ops/add.cpp',
    'pyngraph/ops/and.cpp',
    'pyngraph/ops/argmax.cpp',
    'pyngraph/ops/argmin.cpp',
    'pyngraph/ops/asin.cpp',
    'pyngraph/ops/atan.cpp',
    'pyngraph/ops/avg_pool.cpp',
    'pyngraph/ops/broadcast.cpp',
172
    'pyngraph/ops/broadcast_distributed.cpp',
173 174 175 176 177 178 179 180 181
    'pyngraph/ops/concat.cpp',
    'pyngraph/ops/constant.cpp',
    'pyngraph/ops/convert.cpp',
    'pyngraph/ops/convolution.cpp',
    'pyngraph/ops/cos.cpp',
    'pyngraph/ops/cosh.cpp',
    'pyngraph/ops/ceiling.cpp',
    'pyngraph/ops/divide.cpp',
    'pyngraph/ops/dot.cpp',
182
    'pyngraph/ops/elu.cpp',
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    'pyngraph/ops/equal.cpp',
    'pyngraph/ops/exp.cpp',
    'pyngraph/ops/floor.cpp',
    'pyngraph/ops/greater.cpp',
    'pyngraph/ops/greater_eq.cpp',
    'pyngraph/ops/less.cpp',
    'pyngraph/ops/less_eq.cpp',
    'pyngraph/ops/log.cpp',
    'pyngraph/ops/lrn.cpp',
    'pyngraph/ops/maximum.cpp',
    'pyngraph/ops/max.cpp',
    'pyngraph/ops/product.cpp',
    'pyngraph/ops/max_pool.cpp',
    'pyngraph/ops/minimum.cpp',
    'pyngraph/ops/multiply.cpp',
    'pyngraph/ops/negative.cpp',
    'pyngraph/ops/not.cpp',
    'pyngraph/ops/not_equal.cpp',
    'pyngraph/ops/op.cpp',
    'pyngraph/ops/one_hot.cpp',
    'pyngraph/ops/or.cpp',
    'pyngraph/ops/pad.cpp',
    'pyngraph/ops/parameter.cpp',
206
    'pyngraph/ops/passthrough.cpp',
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
    'pyngraph/ops/power.cpp',
    'pyngraph/ops/regmodule_pyngraph_op.cpp',
    'pyngraph/ops/relu.cpp',
    'pyngraph/ops/replace_slice.cpp',
    'pyngraph/ops/reshape.cpp',
    'pyngraph/ops/reverse.cpp',
    'pyngraph/ops/select.cpp',
    'pyngraph/ops/sign.cpp',
    'pyngraph/ops/sin.cpp',
    'pyngraph/ops/sinh.cpp',
    'pyngraph/ops/slice.cpp',
    'pyngraph/ops/sqrt.cpp',
    'pyngraph/ops/subtract.cpp',
    'pyngraph/ops/sum.cpp',
    'pyngraph/ops/tan.cpp',
    'pyngraph/ops/tanh.cpp',
    'pyngraph/ops/topk.cpp',
    'pyngraph/ops/allreduce.cpp',
    'pyngraph/ops/get_output_element.cpp',
    'pyngraph/ops/min.cpp',
    'pyngraph/ops/batch_norm.cpp',
    'pyngraph/ops/softmax.cpp',
229
    'pyngraph/ops/result.cpp',
230
    'pyngraph/runtime/backend.cpp',
231
    'pyngraph/runtime/executable.cpp',
232 233 234 235 236 237 238 239 240
    'pyngraph/runtime/regmodule_pyngraph_runtime.cpp',
    'pyngraph/runtime/tensor.cpp',
    'pyngraph/passes/manager.cpp',
    'pyngraph/passes/regmodule_pyngraph_passes.cpp',
    'pyngraph/types/element_type.cpp',
    'pyngraph/types/regmodule_pyngraph_types.cpp',
]

package_dir = {
241 242 243 244 245 246 247
    'ngraph': PYNGRAPH_ROOT_DIR + '/ngraph',
    'ngraph.utils': PYNGRAPH_ROOT_DIR + '/ngraph/utils',
    'ngraph.impl': PYNGRAPH_ROOT_DIR + '/ngraph/impl',
    'ngraph.impl.op': PYNGRAPH_ROOT_DIR + '/ngraph/impl/op',
    'ngraph.impl.op.util': PYNGRAPH_ROOT_DIR + '/ngraph/impl/op/util',
    'ngraph.impl.passes': PYNGRAPH_ROOT_DIR + '/ngraph/impl/passes',
    'ngraph.impl.runtime': PYNGRAPH_ROOT_DIR + '/ngraph/impl/runtime',
248 249 250 251 252 253 254 255 256 257
}
packages = [
    'ngraph',
    'ngraph.utils',
    'ngraph.impl',
    'ngraph.impl.op',
    'ngraph.impl.op.util',
    'ngraph.impl.passes',
    'ngraph.impl.runtime',
]
258

259
sources = [PYNGRAPH_ROOT_DIR + '/' + source for source in sources]
260

aslepko's avatar
aslepko committed
261
include_dirs = [PYNGRAPH_ROOT_DIR, NGRAPH_CPP_INCLUDE_DIR, PYBIND11_INCLUDE_DIR]
262

263
library_dirs = [NGRAPH_CPP_LIBRARY_DIR]
264

265
libraries = ['ngraph']
266 267

extra_compile_args = []
268 269
if NGRAPH_ONNX_IMPORT_ENABLE in ['TRUE', 'ON', True]:
    extra_compile_args.append('-DNGRAPH_ONNX_IMPORT_ENABLE')
270 271 272

extra_link_args = []

273 274 275 276
data_files = [
    (
        'lib',
        [
277
            NGRAPH_CPP_LIBRARY_DIR + '/' + library
278 279
            for library in os.listdir(NGRAPH_CPP_LIBRARY_DIR)
        ],
280 281 282 283
    ),
    (
        'licenses',
        [
284 285
            NGRAPH_CPP_DIST_DIR + '/licenses/' + license
            for license in os.listdir(NGRAPH_CPP_DIST_DIR + '/licenses')
286 287 288 289
        ],
    ),
    (
        '',
290
        [NGRAPH_CPP_DIST_DIR + '/LICENSE'],
291
    ),
292 293
]

294 295 296 297 298 299 300 301 302 303 304 305
if NGRAPH_ONNX_IMPORT_ENABLE in ['TRUE', 'ON', True]:
    onnx_sources = [
        'pyngraph/onnx_import/onnx_import.cpp',
    ]
    onnx_sources = [PYNGRAPH_ROOT_DIR + '/' + source for source in onnx_sources]
    sources = sources + onnx_sources

    package_dir['ngraph.impl.onnx_import'] = (
        PYNGRAPH_ROOT_DIR + '/ngraph/impl/onnx_import'
    )
    packages.append('ngraph.impl.onnx_import')

306 307 308 309 310
ext_modules = [
    Extension(
        '_pyngraph',
        sources=sources,
        include_dirs=include_dirs,
311
        define_macros=[('VERSION_INFO', __version__)],
312 313
        library_dirs=library_dirs,
        libraries=libraries,
314
        extra_compile_args=extra_compile_args,
315
        extra_link_args=extra_link_args,
316 317
        language='c++',
    ),
318 319
]

320

321 322 323 324 325 326 327 328 329
def add_platform_specific_link_args(link_args):
    """Add linker flags specific for actual OS."""
    if sys.platform.startswith('linux'):
        link_args += ['-Wl,-rpath,$ORIGIN/../..']
        link_args += ['-z', 'noexecstack']
        link_args += ['-z', 'relro']
        link_args += ['-z', 'now']
    elif sys.platform == 'darwin':
        link_args += ['-Wl,-rpath,@loader_path/../..']
330
        link_args += ['-stdlib=libc++']
331 332


333
class BuildExt(build_ext):
334 335 336 337 338 339 340 341
    """A custom build extension for adding compiler-specific options."""

    def _add_extra_compile_arg(self, flag, compile_args):
        """Return True if successfully added given flag to compiler args."""
        if has_flag(self.compiler, flag):
            compile_args += [flag]
            return True
        return False
342

343
    def build_extensions(self):
344
        """Build extension providing extra compiler flags."""
345 346
        if sys.platform == 'win32':
            raise RuntimeError('Unsupported platform: win32!')
347
        # -Wstrict-prototypes is not a valid option for c++
348
        try:
349
            self.compiler.compiler_so.remove('-Wstrict-prototypes')
350 351
        except (AttributeError, ValueError):
            pass
352 353
        for ext in self.extensions:
            ext.extra_compile_args += [cpp_flag(self.compiler)]
354 355 356 357 358 359 360 361 362

            if not self._add_extra_compile_arg('-fstack-protector-strong', ext.extra_compile_args):
                self._add_extra_compile_arg('-fstack-protector', ext.extra_compile_args)

            self._add_extra_compile_arg('-fvisibility=hidden', ext.extra_compile_args)
            self._add_extra_compile_arg('-flto', ext.extra_compile_args)
            self._add_extra_compile_arg('-fPIC', ext.extra_compile_args)
            add_platform_specific_link_args(ext.extra_link_args)

363
            ext.extra_compile_args += ['-Wformat', '-Wformat-security']
364
            ext.extra_compile_args += ['-O2', '-D_FORTIFY_SOURCE=2']
365 366
            if sys.platform == 'darwin':
                ext.extra_compile_args += ['-stdlib=libc++']
367 368 369
        build_ext.build_extensions(self)


aslepko's avatar
aslepko committed
370
with open(os.path.join(PYNGRAPH_ROOT_DIR, 'requirements.txt')) as req:
371
    requirements = req.read().splitlines()
372 373 374
    setup_requires = [
        item for item in requirements if item.strip().startswith('numpy')
    ]
375 376

setup(
377
    name='ngraph-core',
378
    description="nGraph - Intel's graph compiler and runtime for Neural Networks",
379
    version=__version__,
380
    author='Intel Corporation',
381
    author_email='intelnervana@intel.com',
382
    url='https://github.com/NervanaSystems/ngraph/',
383
    license='License :: OSI Approved :: Apache Software License',
384 385
    long_description=open(os.path.join(PYNGRAPH_ROOT_DIR, 'README.md')).read(),
    long_description_content_type='text/markdown',
386
    ext_modules=ext_modules,
387
    package_dir=package_dir,
388
    packages=packages,
389
    cmdclass={'build_ext': BuildExt},
390
    data_files=data_files,
391
    setup_requires=setup_requires,
392
    install_requires=requirements,
393
    zip_safe=False,
394
    extras_require={
395
        'plaidml': ['plaidml>=0.6.3'],
396
    },
397
)