[WIP][docs] update Python-package installation guide #6767
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,10 +34,14 @@ | |
| # OpenCL include directory. | ||
| # --opencl-library=FILEPATH | ||
| # Path to OpenCL library. | ||
| # --sanitizers=LIST_OF_SANITIZERS | ||
| # Semicolon separated list with chosen compiler sanitizers. | ||
| # --bit32 | ||
| # Compile 32-bit version. | ||
| # --cuda | ||
| # Compile CUDA version. | ||
| # --debug | ||
| # Compile in debug mode. | ||
| # --gpu | ||
| # Compile GPU version. | ||
| # --integrated-opencl | ||
|
|
@@ -49,20 +53,22 @@ | |
| # --no-isolation | ||
| # Assume all build and install dependencies are already installed, | ||
| # don't go to the internet to get them. | ||
| # --nohomebrew | ||
| # Compile version ignoring Homebrew standard folders for finding dependencies. | ||
| # --nomp | ||
| # Compile version without OpenMP support. | ||
| # --precompile | ||
| # Use precompiled library. | ||
| # Only used with 'install' command. | ||
| # --time-costs | ||
| # Compile version that outputs time costs for different internal routines. | ||
| # --user | ||
| # Install into user-specific instead of global site-packages directory. | ||
| # Only used with 'install' command. | ||
|
|
||
| set -e -u | ||
|
|
||
| echo "[INFO] building lightgbm" | ||
|
There was a problem hiding this comment. For the consistency with Line 141 in 60b0155 and to better distinguish between our own logs and scikit-build-core ones. |
||
|
|
||
| # Default values of arguments | ||
| INSTALL="false" | ||
|
|
@@ -132,27 +138,38 @@ while [ $# -gt 0 ]; do | |
| OPENCL_LIBRARY="${1#*=}" | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.OpenCL_LIBRARY='${OPENCL_LIBRARY}'" | ||
| ;; | ||
| --sanitizers|--sanitizers=*) | ||
| if echo "$1" | grep -q '^*=*$'; | ||
| then shift; | ||
| fi | ||
| SANITIZERS="${1#*=}" | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_SANITIZER=ON" | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.ENABLED_SANITIZERS='${SANITIZERS}'" | ||
| ;; | ||
| ######### | ||
| # flags # | ||
| ######### | ||
| --bit32) | ||
|
There was a problem hiding this comment. Allow to use any default Visual Studio version. |
||
| echo "[INFO] Attempting to build 32-bit version of LightGBM, which is only supported on Windows with Visual Studio." | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.args=-AWin32" | ||
| ;; | ||
| --cuda) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_CUDA=ON" | ||
| ;; | ||
| --debug) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_DEBUG=ON" | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.build-type=Debug" | ||
| ;; | ||
| --gpu) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_GPU=ON" | ||
| ;; | ||
| --integrated-opencl) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.__INTEGRATE_OPENCL=ON" | ||
| ;; | ||
| --mingw) | ||
| # ref: https://stackoverflow.com/a/45104058/3986677 | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.CMAKE_SH=CMAKE_SH-NOTFOUND" | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.args=-G'MinGW Makefiles'" | ||
| ;; | ||
| --mpi) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_MPI=ON" | ||
|
|
@@ -161,6 +178,9 @@ while [ $# -gt 0 ]; do | |
| BUILD_ARGS="${BUILD_ARGS} --no-isolation" | ||
| PIP_INSTALL_ARGS="${PIP_INSTALL_ARGS} --no-build-isolation" | ||
| ;; | ||
| --nohomebrew) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_HOMEBREW_FALLBACK=OFF" | ||
| ;; | ||
| --nomp) | ||
| BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.USE_OPENMP=OFF" | ||
| ;; | ||
|
|
@@ -174,7 +194,7 @@ while [ $# -gt 0 ]; do | |
| PIP_INSTALL_ARGS="${PIP_INSTALL_ARGS} --user" | ||
| ;; | ||
| *) | ||
| echo "[ERROR] invalid argument '${1}'. Aborting" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
|
|
@@ -315,18 +335,28 @@ if test "${INSTALL}" = true; then | |
| echo "" >> ./MANIFEST.in | ||
| mkdir -p ./lightgbm/lib | ||
| if test -f ../lib_lightgbm.so; then | ||
| echo "[INFO] found pre-compiled lib_lightgbm.so" | ||
| cp ../lib_lightgbm.so ./lightgbm/lib/lib_lightgbm.so | ||
| elif test -f ../lib_lightgbm.dylib; then | ||
| echo "[INFO] found pre-compiled lib_lightgbm.dylib" | ||
| cp ../lib_lightgbm.dylib ./lightgbm/lib/lib_lightgbm.dylib | ||
| elif test -f ../lib_lightgbm.dll; then | ||
| echo "[INFO] found pre-compiled lib_lightgbm.dll" | ||
| cp ../lib_lightgbm.dll ./lightgbm/lib/lib_lightgbm.dll | ||
|
Comment on lines
+343
to
+345
There was a problem hiding this comment. Can be located there after compilation with MinGW: https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#mingw-w64 |
||
| elif test -f ../Release/lib_lightgbm.dll; then | ||
| echo "[INFO] found pre-compiled Release/lib_lightgbm.dll" | ||
| cp ../Release/lib_lightgbm.dll ./lightgbm/lib/lib_lightgbm.dll | ||
| elif test -f ../windows/x64/DLL/lib_lightgbm.dll; then | ||
| echo "[INFO] found pre-compiled windows/x64/DLL/lib_lightgbm.dll" | ||
| cp ../windows/x64/DLL/lib_lightgbm.dll ./lightgbm/lib/lib_lightgbm.dll | ||
| cp ../windows/x64/DLL/lib_lightgbm.lib ./lightgbm/lib/lib_lightgbm.lib | ||
| elif test -f ../windows/x64/Debug_DLL/lib_lightgbm.dll; then | ||
| echo "[INFO] found pre-compiled windows/x64/Debug_DLL/lib_lightgbm.dll" | ||
| cp ../windows/x64/Debug_DLL/lib_lightgbm.dll ./lightgbm/lib/lib_lightgbm.dll | ||
| cp ../windows/x64/Debug_DLL/lib_lightgbm.lib ./lightgbm/lib/lib_lightgbm.lib | ||
|
Comment on lines
+353
to
+356
There was a problem hiding this comment. Can be located there after compilation with LightGBM/windows/LightGBM.vcxproj Lines 4 to 6 in 60b0155 |
||
| else | ||
| echo "[ERROR] cannot find pre-compiled library. Aborting" | ||
| exit 1 | ||
|
Comment on lines
+357
to
+359
There was a problem hiding this comment. Without this code, script simply builds empty sdist if no pre-compiled file was found. |
||
| fi | ||
| rm -f ./*.bak | ||
| else | ||
|
|
@@ -336,29 +366,27 @@ if test "${INSTALL}" = true; then | |
| fi | ||
|
|
||
| if test "${BUILD_SDIST}" = true; then | ||
| echo "[INFO] --- building sdist ---" | ||
| rm -f ../dist/*.tar.gz | ||
| # use xargs to work with args that contain whitespaces | ||
| # note that empty echo string leads to that xargs doesn't run the command | ||
| # in some implementations of xargs | ||
| # ref: https://stackoverflow.com/a/8296746 | ||
| echo "--sdist --outdir ../dist ${BUILD_ARGS} ." | xargs python -m build | ||
|
Comment on lines
+371
to
+375
There was a problem hiding this comment. Use xargs to handle args with whitespaces, e.g. |
||
| fi | ||
|
|
||
| if test "${BUILD_WHEEL}" = true; then | ||
| echo "[INFO] --- building wheel ---" | ||
| rm -f ../dist/*.whl || true | ||
| # use xargs to work with args that contain whitespaces | ||
| # note that empty echo string leads to that xargs doesn't run the command | ||
| # in some implementations of xargs | ||
| # ref: https://stackoverflow.com/a/8296746 | ||
| echo "--wheel --outdir ../dist ${BUILD_ARGS} ." | xargs python -m build | ||
| fi | ||
|
|
||
| if test "${INSTALL}" = true; then | ||
| echo "[INFO] --- installing lightgbm ---" | ||
| cd ../dist | ||
| if test "${BUILD_WHEEL}" = true; then | ||
| PACKAGE_NAME="$(echo lightgbm*.whl)" | ||
|
|
@@ -377,5 +405,5 @@ if test "${INSTALL}" = true; then | |
| cd ../ | ||
| fi | ||
|
|
||
| echo "[INFO] cleaning up" | ||
| rm -rf ./lightgbm-python | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add missed options from https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst.