README.md 1.04 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Documents

The documentation of LightGBM is generated with Sphinx and recommonmark, and hosted on Read the Docs.

For detail, see:

* [Read the Docs](https://readthedocs.org/)
  * [Welcome to Read The Docs](http://docs.readthedocs.io/)
* [Sphinx](http://www.sphinx-doc.org/)
* [recommonmark](https://recommonmark.readthedocs.io/)

## Build

You can build the documentation locally. Just run:

```sh
pip install -r requirements.txt
make html
```

## Links

Guolin Ke's avatar
Guolin Ke committed
23
24
25
* [Installation Guide](https://github.com/Microsoft/LightGBM/wiki/Installation-Guide)
* [Quick Start](./Quick-Start.md)
* [Python Quick Start](./Python-intro.md)
Guolin Ke's avatar
Guolin Ke committed
26
* [Features](https://github.com/Microsoft/LightGBM/wiki/Features)
27
* [Experiments](https://github.com/Microsoft/LightGBM/wiki/Experiments)
Guolin Ke's avatar
Guolin Ke committed
28
29
* [Parameters](./Parameters.md)
* [Parameters Tuning](./Parameters-tuning.md)
Guolin Ke's avatar
Guolin Ke committed
30
31
* [Python API Reference](./Python-API.md)
* [Parallel Learning Guide](https://github.com/Microsoft/LightGBM/wiki/Parallel-Learning-Guide)
Qiwei Ye's avatar
Qiwei Ye committed
32
* [GPU Tutorial](./GPU-Tutorial.md)
wxchan's avatar
wxchan committed
33
* [FAQ](./FAQ.md)
34
* [Development Guide](./development.rst)