[docs] update and simplify installation docs#6536
Conversation
|
|
||
| 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.
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
There was a problem hiding this comment.
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.
| :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/ |
Co-authored-by: Nikita Titov <nekit94-08@mail.ru>
StrikerRUS
left a comment
There was a problem hiding this comment.
Thanks a lot for reducing maintenance burden!
|
This pull request has been automatically locked since there has not been any recent activity since it was closed. |
Proposes the following changes to installation docs:
The overall goals of this PR are:
conda-forgepackagesSpecific changes:
conda-forgepackage to get CUDA/GPU builds, and remove language about it not being maintained by usCMaketo build the Python packagescikit-build-coredoes this automatically (code link)CMakeversionLightGBM/CMakeLists.txt
Line 26 in fec9afa
LightGBM_compilation.logfilesetup.py) (fixes #5061) #5759Notes for Reviewers
ref #5419 (comment)