ncnn/setup.py

import io
import os
import sys
import time
import re
import shutil
import subprocess

from setuptools import setup, find_packages, Extension
from setuptools.command.build_ext import build_ext
from setuptools.command.install import install


def find_version():
    with io.open("CMakeLists.txt", encoding="utf8") as f:
        version_file = f.read()

    version_major = re.findall(r"NCNN_VERSION_MAJOR (.+?)", version_file)
    version_minor = re.findall(r"NCNN_VERSION_MINOR (.+?)", version_file)

    if version_major and version_minor:
        ncnn_version = time.strftime("%Y%m%d", time.localtime())

        return version_major[0] + "." + version_minor[0] + "." + ncnn_version
    raise RuntimeError("Unable to find version string.")

# Parse environment variables
Vulkan_LIBRARY = os.environ.get("Vulkan_LIBRARY", "")
CMAKE_TOOLCHAIN_FILE = os.environ.get("CMAKE_TOOLCHAIN_FILE", "")
PLATFORM = os.environ.get("PLATFORM", "")
ARCHS = os.environ.get("ARCHS", "")
DEPLOYMENT_TARGET = os.environ.get("DEPLOYMENT_TARGET", "")
OpenMP_C_FLAGS = os.environ.get("OpenMP_C_FLAGS", "")
OpenMP_CXX_FLAGS = os.environ.get("OpenMP_CXX_FLAGS", "")
OpenMP_C_LIB_NAMES = os.environ.get("OpenMP_C_LIB_NAMES", "")
OpenMP_CXX_LIB_NAMES = os.environ.get("OpenMP_CXX_LIB_NAMES", "")
OpenMP_libomp_LIBRARY = os.environ.get("OpenMP_libomp_LIBRARY", "")
ENABLE_BITCODE = os.environ.get("ENABLE_BITCODE", "")
ENABLE_ARC = os.environ.get("ENABLE_ARC", "")
ENABLE_VISIBILITY = os.environ.get("ENABLE_VISIBILITY", "")

# Parse variables from command line with setup.py install
class InstallCommand(install):
    user_options = install.user_options + [
        ('vulkan=', None, 'Enable the usage of Vulkan.'),
    ]
    def initialize_options(self):
        install.initialize_options(self)
        self.vulkan = None

    def finalize_options(self):
        install.finalize_options(self)

    def run(self):
        install.run(self)

# Convert distutils Windows platform specifiers to CMake -A arguments
PLAT_TO_CMAKE = {
    "win32": "Win32",
    "win-amd64": "x64",
    "win-arm32": "ARM",
    "win-arm64": "ARM64",
}

# A CMakeExtension needs a sourcedir instead of a file list.
# The name must be the _single_ output extension from the CMake build.
# If you need multiple extensions, see scikit-build.
class CMakeExtension(Extension):
    def __init__(self, name, sourcedir=""):
        Extension.__init__(self, name, sources=[])
        self.sourcedir = os.path.abspath(sourcedir)


class CMakeBuild(build_ext):
    def build_extension(self, ext):
        extdir = os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.name)))
        extdir = os.path.join(extdir, "ncnn")

        # required for auto-detection of auxiliary "native" libs
        if not extdir.endswith(os.path.sep):
            extdir += os.path.sep

        cfg = "Debug" if self.debug else "Release"

        # CMake lets you override the generator - we need to check this.
        # Can be set with Conda-Build, for example.
        cmake_generator = os.environ.get("CMAKE_GENERATOR", "")

        # Set Python_EXECUTABLE instead if you use PYBIND11_FINDPYTHON
        # EXAMPLE_VERSION_INFO shows you how to pass a value into the C++ code
        # from Python.
        cmake_args = [
            "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={}".format(extdir),
            "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE={}".format(extdir),
            "-DPYTHON_EXECUTABLE={}".format(sys.executable),
            "-DCMAKE_BUILD_TYPE={}".format(cfg),  # not used on MSVC, but no harm
            "-DNCNN_PYTHON=ON",
            "-DNCNN_VULKAN=ON",
            "-DNCNN_DISABLE_RTTI=OFF",
            "-DNCNN_DISABLE_EXCEPTION=OFF",
            "-DNCNN_BUILD_BENCHMARK=OFF",
            "-DNCNN_BUILD_EXAMPLES=OFF",
            "-DNCNN_BUILD_TOOLS=OFF",
        ]
        if Vulkan_LIBRARY != "":
            cmake_args.append("-DVulkan_LIBRARY=" + Vulkan_LIBRARY)
        if CMAKE_TOOLCHAIN_FILE != "":
            cmake_args.append("-DCMAKE_TOOLCHAIN_FILE=" + CMAKE_TOOLCHAIN_FILE)
        if PLATFORM != "":
            cmake_args.append("-DPLATFORM=" + PLATFORM)
        if ARCHS != "":
            cmake_args.append("-DARCHS=" + ARCHS)
        if DEPLOYMENT_TARGET != "":
            cmake_args.append("-DDEPLOYMENT_TARGET=" + DEPLOYMENT_TARGET)
        if OpenMP_C_FLAGS != "":
            cmake_args.append("-DOpenMP_C_FLAGS=" + OpenMP_C_FLAGS)
        if OpenMP_CXX_FLAGS != "":
            cmake_args.append("-DOpenMP_CXX_FLAGS=" + OpenMP_CXX_FLAGS)
        if OpenMP_C_LIB_NAMES != "":
            cmake_args.append("-DOpenMP_C_LIB_NAMES=" + OpenMP_C_LIB_NAMES)
        if OpenMP_CXX_LIB_NAMES != "":
            cmake_args.append("-DOpenMP_CXX_LIB_NAMES=" + OpenMP_CXX_LIB_NAMES)
        if OpenMP_libomp_LIBRARY != "":
            cmake_args.append("-DOpenMP_libomp_LIBRARY=" + OpenMP_libomp_LIBRARY)
        if ENABLE_BITCODE != "":
            cmake_args.append("-DENABLE_BITCODE=" + ENABLE_BITCODE)
        if ENABLE_ARC != "":
            cmake_args.append("-DENABLE_ARC=" + ENABLE_ARC)
        if ENABLE_VISIBILITY != "":
            cmake_args.append("-DENABLE_VISIBILITY=" + ENABLE_VISIBILITY)

        build_args = []

        if self.compiler.compiler_type == "msvc":
            # Single config generators are handled "normally"
            single_config = any(x in cmake_generator for x in {"NMake", "Ninja"})

            # CMake allows an arch-in-generator style for backward compatibility
            contains_arch = any(x in cmake_generator for x in {"ARM", "Win64"})

            # Specify the arch if using MSVC generator, but only if it doesn't
            # contain a backward-compatibility arch spec already in the
            # generator name.
            if not single_config and not contains_arch:
                cmake_args += ["-A", PLAT_TO_CMAKE[self.plat_name]]

            # Multi-config generators have a different way to specify configs
            if not single_config:
                cmake_args += [
                    "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY_{}={}".format(cfg.upper(), extdir)
                ]
                build_args += ["--config", cfg]

        # Set CMAKE_BUILD_PARALLEL_LEVEL to control the parallel build level
        # across all generators.
        if "CMAKE_BUILD_PARALLEL_LEVEL" not in os.environ:
            # self.parallel is a Python 3 only way to set parallel jobs by hand
            # using -j in the build_ext call, not supported by pip or PyPA-build.
            if hasattr(self, "parallel") and self.parallel:
                # CMake 3.12+ only.
                build_args += ["-j{}".format(self.parallel)]
            else:
                # Automatically set parallel jobs based on CPU core count
                cpu_count = os.cpu_count() or 1
                build_args += ["-j{}".format(cpu_count)]

        if not os.path.exists(self.build_temp):
            os.makedirs(self.build_temp)

        subprocess.check_call(
            ["cmake", ext.sourcedir] + cmake_args, cwd=self.build_temp
        )
        subprocess.check_call(
            ["cmake", "--build", "."] + build_args, cwd=self.build_temp
        )


if sys.version_info < (3, 0):
    sys.exit("Sorry, Python < 3.0 is not supported")

requirements = ["numpy", "tqdm", "requests", "portalocker", "opencv-python"]
setup_requires = []
if shutil.which("cmake") is None:
    setup_requires += ["cmake>=3.12"]
if shutil.which("ninja") is None:
    setup_requires += ["ninja; sys_platform != 'win32'"]

with io.open("README.md", encoding="utf-8") as h:
    long_description = h.read()

setup(
    name="ncnn",
    version=find_version(),
    author="nihui",
    author_email="nihuini@tencent.com",
    maintainer="caishanli",
    maintainer_email="caishanli25@gmail.com",
    description="ncnn is a high-performance neural network inference framework optimized for the mobile platform",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/Tencent/ncnn",
    classifiers=[
        "Programming Language :: C++",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
        "License :: OSI Approved :: BSD License",
        "Operating System :: OS Independent",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
    ],
    license="BSD-3",
    python_requires=">=3.5",
    packages=find_packages("python"),
    package_dir={"": "python"},
    setup_requires=setup_requires,
    install_requires=requirements,
    ext_modules=[CMakeExtension("ncnn")],
    cmdclass={'install': InstallCommand, "build_ext": CMakeBuild},
)