Python-API.rst 968 Bytes
Newer Older
1
2
Python API
==========
3

4
5
.. currentmodule:: lightgbm

6
Data Structure API
7
8
------------------

9
10
.. autosummary::
    :toctree: pythonapi/
11

12
13
    Dataset
    Booster
14
    CVBooster
15
    Sequence
16
17
18
19

Training API
------------

20
21
.. autosummary::
    :toctree: pythonapi/
22

23
24
    train
    cv
25
26

Scikit-learn API
27
28
----------------

29
30
.. autosummary::
    :toctree: pythonapi/
31

32
33
34
35
    LGBMModel
    LGBMClassifier
    LGBMRegressor
    LGBMRanker
36

37
38
39
Dask API
--------

40
41
.. versionadded:: 3.2.0

42
43
44
45
46
47
48
.. autosummary::
    :toctree: pythonapi/

    DaskLGBMClassifier
    DaskLGBMRegressor
    DaskLGBMRanker

49
50
51
Callbacks
---------

52
53
.. autosummary::
    :toctree: pythonapi/
54

55
    early_stopping
56
    log_evaluation
57
58
    record_evaluation
    reset_parameter
59
60
61
62

Plotting
--------

63
64
.. autosummary::
    :toctree: pythonapi/
65

66
67
68
69
70
    plot_importance
    plot_split_value_histogram
    plot_metric
    plot_tree
    create_tree_digraph
71
72
73
74
75
76
77
78

Utilities
---------

.. autosummary::
    :toctree: pythonapi/

    register_logger