LightGBM/docs
Nikita Titov 41152eab4b [python][docs] reworked predict method in sklearn wrapper and docs improvements (#1351)
* fixed docs

* reworker predict method of sklearn wrapper

* fixed encapsulation

* added test

* fixed consistency between docstring and params docs

* fixed verbose

* replaced predict_proba with predict in test

* fixed verbose again

* fixed fraction params descriptions

* added description of skip_drop and drop_rate constraints

* fixed subsample_freq consistency with C++ default value

* fixed nice look of params list

* made force splits json file example clickable

* fixed nice look of metrics list and added comma

* reduced warning in test about same param specified twice

* replaced pred_parameter with **kwargs in predict method

* added test for **kwargs in predict method

* fixed warnings

* fixed pylint
2018-05-10 17:48:29 +08:00
..
_static updated docs (#1239) 2018-02-10 16:24:31 +03:00
.linkcheckerrc [docs] move wiki to Read the Docs (#945) 2017-10-07 23:43:58 +08:00
Advanced-Topics.rst reduce parameters in categorical split 2017-10-17 01:58:15 +08:00
Development-Guide.rst [docs] Minor fix (#1164) 2018-01-02 16:46:36 +03:00
Experiments.rst fix the error in the number of experiments (#1194) 2018-01-11 17:31:22 +08:00
FAQ.rst [docs] fixed link in README (#1050) 2017-11-13 14:13:35 +08:00
Features.rst [docs] fix broken url (#1295) 2018-04-05 05:51:01 -07:00
GPU-Performance.rst [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
GPU-Targets.rst temporarily stop testing gpu (#1365) 2018-05-10 08:37:23 +08:00
GPU-Tutorial.rst [docs] Update GPU documentations 2018-01-08 19:28:22 -08:00
GPU-Windows.rst temporarily stop testing gpu (#1365) 2018-05-10 08:37:23 +08:00
Installation-Guide.rst temporarily stop testing gpu (#1365) 2018-05-10 08:37:23 +08:00
Key-Events.md [docs] move wiki to Read the Docs (#945) 2017-10-07 23:43:58 +08:00
Makefile [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
Parallel-Learning-Guide.rst [docs] documentation improvement (#976) 2017-10-12 21:34:23 +09:00
Parameters-Tuning.rst fix a typo in the docs (#1203) 2018-01-16 17:21:54 +08:00
Parameters.rst [python][docs] reworked predict method in sklearn wrapper and docs improvements (#1351) 2018-05-10 17:48:29 +08:00
Python-API.rst [docs] move wiki to Read the Docs (#945) 2017-10-07 23:43:58 +08:00
Python-Intro.rst [python][docs] add info on adaptive learning rate in the sklearn API (#1354) 2018-05-05 09:09:58 +08:00
Quick-Start.rst [docs] aliases (#1209) 2018-01-22 10:29:36 +08:00
README.rst [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
conf.py [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
gcc-Tips.rst [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
index.rst [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00
make.bat [docs] fixed building at Python 2.x (#997) 2017-10-30 11:44:08 +08:00

README.rst

Documentation
=============

Documentation for LightGBM is generated using `Sphinx <http://www.sphinx-doc.org/>`__.

After each commit on ``master``, documentation is updated and published to `Read the Docs <https://lightgbm.readthedocs.io/>`__.

Build
-----

You can build the documentation locally. Just run in ``docs`` folder

for Python 3.x:

.. code:: sh

    pip install sphinx sphinx_rtd_theme
    make html

 
for Python 2.x:

.. code:: sh

    pip install mock sphinx sphinx_rtd_theme
    make html