0715ab3c10
This PR adds optional support for loading nccl with `dlopen` as an alternative of compile time linking. This is to address the size bloat issue with the PyPI binary release. - Add CMake option to load `nccl` at runtime. - Add an NCCL stub. After this, `nccl` will be fetched from PyPI when using pip to install XGBoost, either by a user or by `pyproject.toml`. Others who want to link the nccl at compile time can continue to do so without any change. At the moment, this is Linux only since we only support MNMG on Linux.
54 lines
1.9 KiB
Python
54 lines
1.9 KiB
Python
"""Build configuration"""
|
|
import dataclasses
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
|
|
@dataclasses.dataclass
|
|
class BuildConfiguration: # pylint: disable=R0902
|
|
"""Configurations use when building libxgboost"""
|
|
|
|
# Whether to hide C++ symbols in libxgboost.so
|
|
hide_cxx_symbols: bool = True
|
|
# Whether to enable OpenMP
|
|
use_openmp: bool = True
|
|
# Whether to enable CUDA
|
|
use_cuda: bool = False
|
|
# Whether to enable NCCL
|
|
use_nccl: bool = False
|
|
# Whether to load nccl dynamically
|
|
use_dlopen_nccl: bool = False
|
|
# Whether to enable HDFS
|
|
use_hdfs: bool = False
|
|
# Whether to enable Azure Storage
|
|
use_azure: bool = False
|
|
# Whether to enable AWS S3
|
|
use_s3: bool = False
|
|
# Whether to enable the dense parser plugin
|
|
plugin_dense_parser: bool = False
|
|
# Special option: See explanation below
|
|
use_system_libxgboost: bool = False
|
|
|
|
def _set_config_setting(self, config_settings: Dict[str, Any]) -> None:
|
|
for field_name in config_settings:
|
|
setattr(
|
|
self,
|
|
field_name,
|
|
(config_settings[field_name].lower() in ["true", "1", "on"]),
|
|
)
|
|
|
|
def update(self, config_settings: Optional[Dict[str, Any]]) -> None:
|
|
"""Parse config_settings from Pip (or other PEP 517 frontend)"""
|
|
if config_settings is not None:
|
|
self._set_config_setting(config_settings)
|
|
|
|
def get_cmake_args(self) -> List[str]:
|
|
"""Convert build configuration to CMake args"""
|
|
cmake_args = []
|
|
for field_name in [x.name for x in dataclasses.fields(self)]:
|
|
if field_name in ["use_system_libxgboost"]:
|
|
continue
|
|
cmake_option = field_name.upper()
|
|
cmake_value = "ON" if getattr(self, field_name) is True else "OFF"
|
|
cmake_args.append(f"-D{cmake_option}={cmake_value}")
|
|
return cmake_args
|