Skip to content
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.

Sign up for GitHub

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] Improve docs: fix consistency of dots in C API and add notes about new time-costs Python-package build option #5554

Merged
merged 3 commits into from
Nov 3, 2022
Merged

[docs] Improve docs: fix consistency of dots in C API and add notes about new time-costs Python-package build option #5554

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35c7e0e
Update c_api.h
StrikerRUS Oct 22, 2022
0ce3569
Update README.rst
StrikerRUS Oct 22, 2022
7df30b1
Merge branch 'master' into improve_docs
jameslamb Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions include/LightGBM/c_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,10 +597,10 @@ LIGHTGBM_C_EXPORT int LGBM_BoosterLoadModelFromString(const char* model_str,

/*!
* \brief Get parameters as JSON string.
* \param handle Handle of booster.
* \param buffer_len Allocated space for string.
* \param[out] out_len Actual size of string.
* \param[out] out_str JSON string containing parameters.
* \param handle Handle of booster
* \param buffer_len Allocated space for string
* \param[out] out_len Actual size of string
* \param[out] out_str JSON string containing parameters
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterGetLoadedParam(BoosterHandle handle,
Expand Down
4 changes: 3 additions & 1 deletion python-package/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ By default, installation in environment with 32-bit Python is prohibited. Howeve

It is **strongly not recommended** to use this version of LightGBM!

Build with time costs output
Build with Time Costs Output
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: sh
Expand Down Expand Up @@ -217,6 +217,8 @@ Run ``python setup.py install --hdfs`` to enable HDFS support. All requirements

Run ``python setup.py install --bit32``, if you want to use 32-bit version. All requirements from `Build 32-bit Version with 32-bit Python section <#build-32-bit-version-with-32-bit-python>`__ apply for this installation option as well.

Run ``python setup.py install --time-costs``, if you want to output time costs for different internal routines. All requirements from `Build with Time Costs Output section <#build-with-time-costs-output>`__ apply for this installation option as well.

If you get any errors during installation or due to any other reasons, you may want to build dynamic library from sources by any method you prefer (see `Installation Guide <https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst>`__) and then just run ``python setup.py install --precompile``.

Build Wheel File
Expand Down