setup_sklearnex.py

#! /usr/bin/env python
# ==============================================================================
# Copyright 2021 Intel Corporation
#
# 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.
# ==============================================================================

# System imports
import os
import sys
import time

from setuptools import setup

from scripts.package_helpers import get_packages_with_tests
from scripts.version import get_onedal_version

sklearnex_version = (
    os.environ["SKLEARNEX_VERSION"]
    if "SKLEARNEX_VERSION" in os.environ
    else time.strftime("%Y%m%d.%H%M%S")
)

IS_WIN = False
IS_MAC = False
IS_LIN = False

if "linux" in sys.platform:
    IS_LIN = True
elif sys.platform == "darwin":
    IS_MAC = True
elif sys.platform in ["win32", "cygwin"]:
    IS_WIN = True
else:
    assert False, sys.platform + " not supported"

dal_root = os.environ.get("DALROOT")

if dal_root is None:
    raise RuntimeError("Not set DALROOT variable")

trues = ["true", "True", "TRUE", "1", "t", "T", "y", "Y", "Yes", "yes", "YES"]
no_dist = True if "NO_DIST" in os.environ and os.environ["NO_DIST"] in trues else False
dpcpp = True if "DPCPPROOT" in os.environ else False
dpcpp_root = None if not dpcpp else os.environ["DPCPPROOT"]

try:
    import dpctl

    dpctl_available = dpctl.__version__ >= "0.14"
except ImportError:
    import importlib.util

    try:
        dpctl_include = os.path.join(
            importlib.util.find_spec("dpctl").submodule_search_locations[0], "include"
        )
        dpctl_available = dpctl_include is not None
    except AttributeError:
        dpctl_available = False

build_distribute = dpcpp and dpctl_available and not no_dist and IS_LIN

ONEDAL_VERSION = get_onedal_version(dal_root)

project_urls = {
    "Bug Tracker": "https://github.com/intel/scikit-learn-intelex/issues",
    "Documentation": "https://intel.github.io/scikit-learn-intelex/",
    "Source Code": "https://github.com/intel/scikit-learn-intelex",
}

with open("README.md", "r", encoding="utf8") as f:
    long_description = f.read()

packages_with_tests = [
    "sklearnex",
    "sklearnex.cluster",
    "sklearnex.decomposition",
    "sklearnex.ensemble",
    "sklearnex.glob",
    "sklearnex.linear_model",
    "sklearnex.manifold",
    "sklearnex.metrics",
    "sklearnex.model_selection",
    "sklearnex.neighbors",
    "sklearnex.preview",
    "sklearnex.preview.cluster",
    "sklearnex.preview.decomposition",
    "sklearnex.preview.ensemble",
    "sklearnex.preview.linear_model",
    "sklearnex.svm",
    "sklearnex.utils",
]

if build_distribute:
    packages_with_tests += [
        "sklearnex.spmd",
        "sklearnex.spmd.decomposition",
        "sklearnex.spmd.ensemble",
    ]
    if ONEDAL_VERSION >= 20230100:
        packages_with_tests += [
            "sklearnex.spmd.basic_statistics",
            "sklearnex.spmd.linear_model",
            "sklearnex.spmd.neighbors",
        ]
    if ONEDAL_VERSION >= 20230200:
        packages_with_tests += ["sklearnex.spmd.cluster"]

# sklearnex setup
setup(
    name="scikit-learn-intelex",
    description="Intel(R) Extension for Scikit-learn is a "
    "seamless way to speed up your Scikit-learn application.",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="Apache-2.0",
    author="Intel Corporation",
    version=sklearnex_version,
    url="https://github.com/intel/scikit-learn-intelex",
    author_email="onedal.maintainers@intel.com",
    maintainer_email="onedal.maintainers@intel.com",
    project_urls=project_urls,
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Environment :: Console",
        "Intended Audience :: Developers",
        "Intended Audience :: Other Audience",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: Apache Software License",
        "Operating System :: Microsoft :: Windows",
        "Operating System :: POSIX :: Linux",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Topic :: Scientific/Engineering",
        "Topic :: System",
        "Topic :: Software Development",
    ],
    python_requires=">=3.8",
    install_requires=["daal4py>=2024.0", "scikit-learn>=1.0"],
    keywords=[
        "machine learning",
        "scikit-learn",
        "data science",
        "data analytics",
    ],
    packages=get_packages_with_tests(packages_with_tests),
)