-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] update and simplify installation docs #6536
Conversation
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.
Found some other places across the repo where CMake version is mentioned.
@@ -70,17 +70,15 @@ Build from Sources | |||
|
|||
pip install --no-binary lightgbm lightgbm | |||
|
|||
For **Linux** and **macOS** users, installation from sources requires installed `CMake`_. | |||
|
|||
For **Linux** users, **glibc** >= 2.28 is required. Also, in some rare cases you may need to install OpenMP runtime library separately (use your package manager and search for ``lib[g|i]omp`` for doing this). |
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.
Remove this as well?
For **Linux** users, **glibc** >= 2.14 is required for LightGBM ``<=3.3.3`` and **glibc** >= 2.28 is required for newer versions.
LightGBM/python-package/README.rst
Line 25 in 52d40f3
For **Linux** users, **glibc** >= 2.14 is required for LightGBM ``<=3.3.3`` and **glibc** >= 2.28 is required for newer versions. Also, in some rare cases, when you hit ``OSError: libgomp.so.1: cannot open shared object file: No such file or directory`` error during importing LightGBM, you need to install OpenMP runtime library separately (use your package manager and search for ``lib[g|i]omp`` for doing this). |
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.
Yeah I think that makes sense.
At first I'd intentionally left this one in, because it is true that on systems where you have older versions of GLIBC, pip install lightgbm
will return an sdist (that'll have to be compiled) instead of a wheel.
But looking through it again, I do see that the other sections that explicitly talk about sdists (anything about passing --no-binary lightgbm
) are nested underneath this "Install from PyPI" heading. And these GLIBC requirements don't affect your ability to build from an sdist.
I've removed this in 8cee2d6.
@@ -294,4 +298,3 @@ To check that a contribution to the package matches its style expectations, run | |||
:target: https://pepy.tech/project/lightgbm | |||
.. |API Docs| image:: https://readthedocs.org/projects/lightgbm/badge/?version=latest | |||
:target: https://lightgbm.readthedocs.io/en/latest/Python-API.html | |||
.. _CMake: https://cmake.org/ |
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.
Remove CMake version from here as well?
Line 145 in 2bc3ab8
You can perform installation either with **Apple Clang** or **gcc**. In case you prefer **Apple Clang**, you should install **OpenMP** (details for installation can be found in [Installation Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#apple-clang)) first and **CMake** version 3.16 or higher is required. In case you prefer **gcc**, you need to install it (details for installation can be found in [Installation Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#gcc)) and set some environment variables to tell R to use `gcc` and `g++`. If you install these from Homebrew, your versions of `g++` and `gcc` are most likely in `/usr/local/bin`, as shown below. |
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.
Ah yes, missed this one! Removed in 8cee2d6
Co-authored-by: Nikita Titov <[email protected]>
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.
Thanks a lot for reducing maintenance burden!
Proposes the following changes to installation docs:
The overall goals of this PR are:
conda-forge
packagesSpecific changes:
conda-forge
package to get CUDA/GPU builds, and remove language about it not being maintained by usCMake
to build the Python packagescikit-build-core
does this automatically (code link)CMake
versionLightGBM/CMakeLists.txt
Line 26 in fec9afa
LightGBM_compilation.log
filesetup.py
) (fixes #5061) #5759Notes for Reviewers
ref #5419 (comment)