Commit b53cd80f authored by Tsukasa OMOTO's avatar Tsukasa OMOTO Committed by Guolin Ke
Browse files

docs: improve python api documents on Read the Docs (#500)

parent f1b08ac8
lightgbm package lightgbm package
================ ================
lightgbm\.basic
---------------
.. automodule:: lightgbm.basic Data Structure API
:members:
:undoc-members:
:show-inheritance:
lightgbm\.callback
------------------ ------------------
.. automodule:: lightgbm.callback .. autoclass:: lightgbm.Dataset
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
lightgbm\.compat .. autoclass:: lightgbm.Booster
----------------
.. automodule:: lightgbm.compat
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
lightgbm\.engine
Training API
------------
.. autofunction:: lightgbm.train
.. autofunction:: lightgbm.cv
Scikit-learn API
---------------- ----------------
.. automodule:: lightgbm.engine .. autoclass:: lightgbm.LGBMModel
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
lightgbm\.libpath .. autoclass:: lightgbm.LGBMClassifier
-----------------
.. automodule:: lightgbm.libpath
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
lightgbm\.plotting .. autoclass:: lightgbm.LGBMRegressor
------------------
.. automodule:: lightgbm.plotting
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
lightgbm\.sklearn .. autoclass:: lightgbm.LGBMRanker
-----------------
.. automodule:: lightgbm.sklearn
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:
Module contents Callbacks
--------------- ---------
.. autofunction:: lightgbm.early_stopping
.. autofunction:: lightgbm.print_evaluation
.. autofunction:: lightgbm.record_evaluation
.. autofunction:: lightgbm.reset_parameter
Plotting
--------
.. autofunction:: lightgbm.plot_importance
.. autofunction:: lightgbm.plot_metric
.. autofunction:: lightgbm.plot_tree
.. autofunction:: lightgbm.create_tree_digraph
.. automodule:: lightgbm
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment