<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Documentation — LightGBM 3.3.5.99 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="shortcut icon" href="_static/favicon.ico"/> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/sphinx_highlight.js"></script> <script src="_static/js/script.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Recommendations When Using gcc" href="gcc-Tips.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html"> <img src="_static/LightGBM_logo_grey_text.svg" class="logo" alt="Logo"/> </a> <div class="version"> 3.3.5.99 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="Installation-Guide.html">Installation Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="Quick-Start.html">Quick Start</a></li> <li class="toctree-l1"><a class="reference internal" href="Python-Intro.html">Python Quick Start</a></li> <li class="toctree-l1"><a class="reference internal" href="Features.html">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="Experiments.html">Experiments</a></li> <li class="toctree-l1"><a class="reference internal" href="Parameters.html">Parameters</a></li> <li class="toctree-l1"><a class="reference internal" href="Parameters-Tuning.html">Parameters Tuning</a></li> <li class="toctree-l1"><a class="reference internal" href="C-API.html">C API</a></li> <li class="toctree-l1"><a class="reference internal" href="Python-API.html">Python API</a></li> <li class="toctree-l1"><a class="reference external" href="https://lightgbm.readthedocs.io/en/latest/R/reference/">R API</a></li> <li class="toctree-l1"><a class="reference internal" href="Parallel-Learning-Guide.html">Distributed Learning Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="GPU-Tutorial.html">GPU Tutorial</a></li> <li class="toctree-l1"><a class="reference internal" href="Advanced-Topics.html">Advanced Topics</a></li> <li class="toctree-l1"><a class="reference internal" href="FAQ.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="Development-Guide.html">Development Guide</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">LightGBM</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Documentation</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/README.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="documentation"> <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1> <p>Documentation for LightGBM is generated using <a class="reference external" href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="reference external" href="https://breathe.readthedocs.io/">Breathe</a>, which works on top of <a class="reference external" href="https://www.doxygen.nl/index.html">Doxygen</a> output.</p> <p>List of parameters and their descriptions in <a class="reference external" href="./Parameters.html">Parameters.rst</a> is generated automatically from comments in <a class="reference external" href="https://github.com/microsoft/LightGBM/blob/master/include/LightGBM/config.h">config file</a> by <a class="reference external" href="https://github.com/microsoft/LightGBM/blob/master/helpers/parameter_generator.py">this script</a>.</p> <p>After each commit on <code class="docutils literal notranslate"><span class="pre">master</span></code>, documentation is updated and published to <a class="reference external" href="https://lightgbm.readthedocs.io/">Read the Docs</a>.</p> <section id="build"> <h2>Build<a class="headerlink" href="#build" title="Permalink to this heading"></a></h2> <p>It is not necessary to re-build this documentation while modifying LightGBM’s source code. The HTML files generated using <code class="docutils literal notranslate"><span class="pre">Sphinx</span></code> are not checked into source control. However, you may want to build them locally during development to test changes.</p> <section id="docker"> <h3>Docker<a class="headerlink" href="#docker" title="Permalink to this heading"></a></h3> <p>The most reliable way to build the documentation locally is with Docker, using <a class="reference external" href="https://hub.docker.com/r/readthedocs/build">the same images Read the Docs uses</a>.</p> <p>Run the following from the root of this repository to pull the relevant image and run a container locally.</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>run<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--user<span class="o">=</span><span class="m">0</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/opt/LightGBM<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--env<span class="w"> </span><span class="nv">C_API</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--env<span class="w"> </span><span class="nv">CONDA</span><span class="o">=</span>/opt/miniforge<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--env<span class="w"> </span><span class="nv">READTHEDOCS</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--workdir<span class="o">=</span>/opt/LightGBM/docs<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--entrypoint<span class="o">=</span><span class="s2">""</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>readthedocs/build:ubuntu-20.04-2021.09.23<span class="w"> </span><span class="se">\</span> <span class="w"> </span>/bin/bash<span class="w"> </span>build-docs.sh </pre></div> </div> <p>When that code completes, open <code class="docutils literal notranslate"><span class="pre">docs/_build/html/index.html</span></code> in your browser.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The navigation in these locally-built docs does not link to the local copy of the R documentation. To view the local version of the R docs, open <code class="docutils literal notranslate"><span class="pre">docs/_build/html/R/index.html</span></code> in your browser.</p> </div> </section> <section id="without-docker"> <h3>Without Docker<a class="headerlink" href="#without-docker" title="Permalink to this heading"></a></h3> <p>You can build the documentation locally without Docker. Just install Doxygen and run in <code class="docutils literal notranslate"><span class="pre">docs</span></code> folder</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>breathe<span class="w"> </span>sphinx<span class="w"> </span><span class="s1">'sphinx_rtd_theme>=0.5'</span> make<span class="w"> </span>html </pre></div> </div> <p>Note that this will not build the R documentation. Consider using common R utilities for documentation generation, if you need it. Or use the Docker-based approach described above to build the R documentation locally.</p> <p>Optionally, you may also install <code class="docutils literal notranslate"><span class="pre">scikit-learn</span></code> and get richer documentation for the classes in <code class="docutils literal notranslate"><span class="pre">Scikit-learn</span> <span class="pre">API</span></code>.</p> <p>If you faced any problems with Doxygen installation or you simply do not need documentation for C code, it is possible to build the documentation without it:</p> <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>sphinx<span class="w"> </span><span class="s1">'sphinx_rtd_theme>=0.5'</span> <span class="nb">export</span><span class="w"> </span><span class="nv">C_API</span><span class="o">=</span>NO<span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nb">set</span><span class="w"> </span><span class="nv">C_API</span><span class="o">=</span>NO make<span class="w"> </span>html </pre></div> </div> </section> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="gcc-Tips.html" class="btn btn-neutral float-left" title="Recommendations When Using gcc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2023, Microsoft Corporation.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>