LightGBM Python 包
项目描述
安装
准备
不支持 32 位 Python。请安装 64 位版本。如果您强烈需要使用 32 位 Python 进行安装，请参阅使用 32 位 Python构建 32 位版本部分。
从PyPI安装
pip install lightgbm您可能需要先通过pip install wheel 安装轮子。
Wheel 文件中包含的编译库支持开箱即用的GPU和CPU版本。此功能是实验性的，目前仅适用于Windows。要使用GPU版本，您只需要安装 OpenCL 运行时库。对于 NVIDIA 和 AMD GPU，它们包含在显卡的普通驱动程序中，因此无需执行任何操作。如果您希望您的 AMD 或 Intel CPU 像 GPU（用于测试和调试）一样，您可以安装AMD APP SDK。
对于Windows用户，如果未安装Visual Studio （2015 或更高版本），则需要VC 运行时。
对于Linux用户，需要glibc >= 2.14。此外，在极少数情况下，当您遇到OSError: libgomp.so.1: cannot open shared object file: No such file or directory error during importing LightGBM 时，您需要单独安装 OpenMP 运行时库（使用您的包管理器并搜索lib[g|i]omp用于执行此操作）。
对于macOS（我们为 3 个最新的 macOS 版本提供轮子）用户：
从版本 2.2.1 开始，分发轮中的库文件由Apple Clang（版本 2.2.1 - 2.3.1 的 Xcode_8.3.3 和版本 2.3.2 的 Xcode_9.4.1）编译器构建。这意味着您不再需要安装gcc编译器。相反，您需要安装OpenMP库，这是使用Apple Clang编译器在系统上运行 LightGBM 所必需的。您可以通过以下命令安装OpenMP库： brew install libomp。
对于小于 2.2.1 且不小于 2.1.2 的版本，必须先安装支持OpenMP的gcc-8 。请参阅安装指南以安装支持 OpenMP 的gcc - 8。
对于小于 2.1.2 的版本，需要带有OpenMP的gcc-7。
从源头构建
pip install --no-binary :all: lightgbm对于Linux和macOS用户，从源安装需要安装CMake。
对于Linux用户，需要glibc >= 2.14。此外，在极少数情况下，您可能需要单独安装 OpenMP 运行时库（使用包管理器并搜索lib[g|i]omp来执行此操作）。
对于macOS用户，您可以使用Apple Clang或gcc执行安装。
如果你更喜欢Apple Clang，你应该先安装OpenMP（安装细节可以在安装指南中找到）并且需要CMake 3.16 或更高版本。
如果您更喜欢gcc，您需要安装它（安装细节可以在安装指南中找到）并通过运行export CXX=g++-7 CC=gcc-7指定编译器（将“7”替换为您安装的gcc版本）机）首先。
对于Windows用户，需要Visual Studio（或VS Build Tools）。如果您在安装过程中遇到任何错误，您可能需要安装CMake（3.8 或更高版本）。
构建无线程版本
pip install lightgbm --install-option=--nompBuild from Sources 部分中的所有要求（ OpenMP要求除外）也适用于此安装选项。
强烈不推荐使用这个版本的 LightGBM！
构建 MPI 版本
pip install lightgbm --install-option=--mpiBuild from Sources 部分的所有要求也适用于此安装选项。
对于Windows用户，不支持使用MinGW-w64进行编译，强烈要求使用CMake （3.8 或更高版本）。
需要MPI库：可以在安装指南中找到安装的详细信息。
构建 GPU 版本
pip install lightgbm --install-option=--gpuBuild from Sources 部分的所有要求也适用于此安装选项。
对于Windows用户，强烈需要CMake （3.8 或更高版本）。
需要Boost和OpenCL：安装详细信息可以在安装指南中找到。几乎总是你还需要通过pip选项将OpenCL_INCLUDE_DIR、Linux的OpenCL_LIBRARY选项和BOOST_ROOT、Windows的BOOST_LIBRARYDIR选项传递给CMake，例如
pip install lightgbm --install-option=--gpu --install-option="--opencl-include-dir=/usr/local/cuda/include/" --install-option="--opencl-library=/usr/local/cuda/lib64/libOpenCL.so"所有可用选项：
提升根
升压目录
提升包含目录
提升库目录
opencl 包含目录
opencl库
有关更多详细信息，请参阅FindBoost和FindOpenCL。
构建 CUDA 版本
pip install lightgbm --install-option=--cudaBuild from Sources 部分的所有要求也适用于此安装选项，并且强烈需要CMake（版本 3.16 或更高版本）。
需要CUDA库（版本 9.0 或更高版本）：安装详细信息可在安装指南中找到。
构建 HDFS 版本
pip install lightgbm --install-option=--hdfsBuild from Sources 部分的所有要求也适用于此安装选项。
需要HDFS库：安装细节可以在安装指南中找到。
请注意，HDFS 版本的安装过程仅在Linux上进行了测试。
在 Windows 上使用 MinGW-w64 构建
pip install lightgbm --install-option=--mingw应先安装CMake和MinGW-w64 。
推荐使用Visual Studio ，因为它在Windows中对于多核系统具有更好的多线程效率（参见问题 4和问题 8）。
使用 32 位 Python 构建 32 位版本
pip install lightgbm --install-option=--bit32默认情况下，禁止在 32 位 Python 环境中安装。但是，您可以通过传递bit32选项来删除此禁令，风险自负。
强烈不推荐使用这个版本的 LightGBM！
从conda-forge 频道安装
如果您使用conda管理 Python 依赖项，则可以使用 conda install安装 LightGBM 。
注意： LightGBM维护者不维护 lightgbm conda-forge 原料。
conda install -c conda-forge lightgbm从 GitHub 安装
Build from Sources 部分的所有要求也适用于此安装选项。
对于Windows用户，如果您在安装过程中遇到任何错误并且出现警告WARNING:LightGBM:Compilation with MSBuild from existing solution file failed。在日志中，您应该安装CMake（3.8 或更高版本）。
git clone --recursive https://github.com/microsoft/LightGBM.git
cd LightGBM/python-package
# export CXX=g++-7 CC=gcc-7 # macOS users, if you decided to compile with gcc, don't forget to specify compilers (replace "7" with version of gcc installed on your machine)
python setup.py install注意：执行命令可能需要sudo （或Windows中的管理员权限）。
运行python setup.py install --nomp以禁用OpenMP支持。Build Threadless Version 部分的所有要求也适用于此安装选项。
运行python setup.py install --mpi以启用MPI支持。构建 MPI 版本部分的所有要求也适用于此安装选项。
如果您想在Windows上使用MinGW-w64而不是Visual Studio ，请运行python setup.py install --mingw。在 Windows 部分使用 MinGW-w64 构建的所有要求也适用于此安装选项。
运行python setup.py install --gpu以启用 GPU 支持。构建 GPU 版本部分的所有要求也适用于此安装选项。要将其他选项传递给CMake ，请使用以下语法：python setup.py install --gpu --opencl-include-dir=/usr/local/cuda/include/，请参阅构建 GPU 版本部分以获取它们的完整列表。
运行python setup.py install --cuda以启用 CUDA 支持。构建 CUDA 版本部分的所有要求也适用于此安装选项。
运行python setup.py install --hdfs以启用 HDFS 支持。构建 HDFS 版本部分的所有要求也适用于此安装选项。
如果要使用 32 位版本，请运行python setup.py install --bit32 。Build 32-bit Version with 32-bit Python 部分的所有要求也适用于此安装选项。
如果您在安装过程中或由于任何其他原因出现任何错误，您可能希望通过您喜欢的任何方法从源构建动态库（请参阅安装指南），然后只需运行python setup.py install --precompile。
构建轮文件
您可以使用python setup.py bdist_wheel而不是python setup.py install来构建 wheel 文件并在以后使用它进行安装。这对于受限或完全没有网络访问的系统可能很有用。
安装 Dask 包
要安装 Dask 包所需的所有其他依赖项，您可以将[dask]附加到 LightGBM 包名称：
pip install lightgbm[dask]或者，如果您是从源文件安装包，则将python setup.py install替换为pip install -e .[dask] 。
故障排除
如果您在安装过程中遇到任何错误，您可以检查$HOME/LightGBM_compilation.log文件，其中记录了所有操作，以获取有关发生问题的更多详细信息。另外，请将此文件附加到 GitHub 上的问题中，以帮助更快地指出错误原因。
请参阅常见问题解答。
例子
请参阅Python 指南文件夹中的演练示例。
开发指南
Python-package 的代码风格遵循PEP 8。如果您想做出贡献但不熟悉 PEP 8，请先查看 PEP 8 样式指南。否则，检查不会通过。只有 E501（行太长）和 W503（在二元运算符之前发生换行）可以忽略。
文档字符串（docstrings）以 NumPy 风格编写。
