index.rst

.. LightGBM documentation master file, created by
   sphinx-quickstart on Thu May  4 14:30:58 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ./logo/LightGBM_logo_black_text.svg
   :align: center
   :width: 600
   :alt: Light Gradient Boosting Machine logo.

|

Welcome to LightGBM's documentation!
====================================

**LightGBM** is a gradient boosting framework that uses tree based learning algorithms. It is designed to be distributed and efficient with the following advantages:

- Faster training speed and higher efficiency.
- Lower memory usage.
- Better accuracy.
- Support of parallel, distributed, and GPU learning.
- Capable of handling large-scale data.

For more details, please refer to `Features <./Features.rst>`__.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   Installation Guide <Installation-Guide>
   Quick Start <Quick-Start>
   Python Quick Start <Python-Intro>
   Features <Features>
   Experiments <Experiments>
   Parameters <Parameters>
   Parameters Tuning <Parameters-Tuning>
   C API <C-API>
   Python API <Python-API>
   R API <https://lightgbm.readthedocs.io/en/latest/R/reference/>
   Distributed Learning Guide <Parallel-Learning-Guide>
   GPU Tutorial <GPU-Tutorial>
   Advanced Topics <Advanced-Topics>
   FAQ <FAQ>
   Development Guide <Development-Guide>

.. toctree::
   :hidden:

   GPU-Performance
   GPU-Targets
   GPU-Windows
   gcc-Tips
   README

Indices and Tables
==================

* :ref:`genindex`