зеркало из https://github.com/microsoft/LightGBM.git
2db6377a22
* add support of refit-decay * add refit into c_api * add test * update document * Update basic.py * Update test_engine.py * Update basic.py * Update test_engine.py * fix comments * update test * fix the comments * Update test_engine.py |
||
|---|---|---|
| .. | ||
| _static | ||
| .linkcheckerrc | ||
| Advanced-Topics.rst | ||
| Development-Guide.rst | ||
| Experiments.rst | ||
| FAQ.rst | ||
| Features.rst | ||
| GPU-Performance.rst | ||
| GPU-Targets.rst | ||
| GPU-Tutorial.rst | ||
| GPU-Windows.rst | ||
| Installation-Guide.rst | ||
| Key-Events.md | ||
| Makefile | ||
| Parallel-Learning-Guide.rst | ||
| Parameters-Tuning.rst | ||
| Parameters.rst | ||
| Python-API.rst | ||
| Python-Intro.rst | ||
| Quick-Start.rst | ||
| README.rst | ||
| conf.py | ||
| gcc-Tips.rst | ||
| index.rst | ||
| make.bat | ||
README.rst
Documentation
=============
Documentation for LightGBM is generated using `Sphinx <http://www.sphinx-doc.org/>`__.
List of parameters and their descriptions in `Parameters.rst <./Parameters.rst>`__
is generated automatically from comments in `config file <https://github.com/Microsoft/LightGBM/blob/master/include/LightGBM/config.h>`__
by `this script <https://github.com/Microsoft/LightGBM/blob/master/helper/parameter_generator.py>`__.
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>=0.3"
make html
for Python 2.x:
.. code:: sh
pip install mock sphinx "sphinx_rtd_theme>=0.3"
make html