Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tianlh
LightGBM-DCU
Commits
23403a7c
Unverified
Commit
23403a7c
authored
Jan 12, 2023
by
James Lamb
Committed by
GitHub
Jan 12, 2023
Browse files
[python-package] make public API members explicit with module-level __all__ variables (#5655)
parent
e40c9e29
Changes
8
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
48 additions
and
0 deletions
+48
-0
python-package/lightgbm/basic.py
python-package/lightgbm/basic.py
+9
-0
python-package/lightgbm/callback.py
python-package/lightgbm/callback.py
+7
-0
python-package/lightgbm/compat.py
python-package/lightgbm/compat.py
+2
-0
python-package/lightgbm/dask.py
python-package/lightgbm/dask.py
+6
-0
python-package/lightgbm/engine.py
python-package/lightgbm/engine.py
+7
-0
python-package/lightgbm/libpath.py
python-package/lightgbm/libpath.py
+2
-0
python-package/lightgbm/plotting.py
python-package/lightgbm/plotting.py
+8
-0
python-package/lightgbm/sklearn.py
python-package/lightgbm/sklearn.py
+7
-0
No files found.
python-package/lightgbm/basic.py
View file @
23403a7c
...
@@ -20,6 +20,15 @@ import scipy.sparse
...
@@ -20,6 +20,15 @@ import scipy.sparse
from
.compat
import
PANDAS_INSTALLED
,
concat
,
dt_DataTable
,
pd_CategoricalDtype
,
pd_DataFrame
,
pd_Series
from
.compat
import
PANDAS_INSTALLED
,
concat
,
dt_DataTable
,
pd_CategoricalDtype
,
pd_DataFrame
,
pd_Series
from
.libpath
import
find_lib_path
from
.libpath
import
find_lib_path
__all__
=
[
'Booster'
,
'Dataset'
,
'LGBMDeprecationWarning'
,
'LightGBMError'
,
'register_logger'
,
'Sequence'
,
]
_DatasetHandle
=
ctypes
.
c_void_p
_DatasetHandle
=
ctypes
.
c_void_p
_LGBM_EvalFunctionResultType
=
Tuple
[
str
,
float
,
bool
]
_LGBM_EvalFunctionResultType
=
Tuple
[
str
,
float
,
bool
]
_LGBM_BoosterEvalMethodResultType
=
Tuple
[
str
,
str
,
float
,
bool
]
_LGBM_BoosterEvalMethodResultType
=
Tuple
[
str
,
str
,
float
,
bool
]
...
...
python-package/lightgbm/callback.py
View file @
23403a7c
...
@@ -6,6 +6,13 @@ from typing import Any, Callable, Dict, List, Tuple, Union
...
@@ -6,6 +6,13 @@ from typing import Any, Callable, Dict, List, Tuple, Union
from
.basic
import
_ConfigAliases
,
_LGBM_BoosterEvalMethodResultType
,
_log_info
,
_log_warning
from
.basic
import
_ConfigAliases
,
_LGBM_BoosterEvalMethodResultType
,
_log_info
,
_log_warning
__all__
=
[
'early_stopping'
,
'log_evaluation'
,
'record_evaluation'
,
'reset_parameter'
,
]
_EvalResultTuple
=
Union
[
_EvalResultTuple
=
Union
[
List
[
_LGBM_BoosterEvalMethodResultType
],
List
[
_LGBM_BoosterEvalMethodResultType
],
List
[
Tuple
[
str
,
str
,
float
,
bool
,
float
]]
List
[
Tuple
[
str
,
str
,
float
,
bool
,
float
]]
...
...
python-package/lightgbm/compat.py
View file @
23403a7c
...
@@ -194,3 +194,5 @@ except ImportError:
...
@@ -194,3 +194,5 @@ except ImportError:
def
_LGBMCpuCount
(
only_physical_cores
:
bool
=
True
):
def
_LGBMCpuCount
(
only_physical_cores
:
bool
=
True
):
return
cpu_count
()
return
cpu_count
()
__all__
=
[]
python-package/lightgbm/dask.py
View file @
23403a7c
...
@@ -25,6 +25,12 @@ from .sklearn import (LGBMClassifier, LGBMModel, LGBMRanker, LGBMRegressor, _LGB
...
@@ -25,6 +25,12 @@ from .sklearn import (LGBMClassifier, LGBMModel, LGBMRanker, LGBMRegressor, _LGB
_LGBM_ScikitEvalMetricType
,
_lgbmmodel_doc_custom_eval_note
,
_lgbmmodel_doc_fit
,
_LGBM_ScikitEvalMetricType
,
_lgbmmodel_doc_custom_eval_note
,
_lgbmmodel_doc_fit
,
_lgbmmodel_doc_predict
)
_lgbmmodel_doc_predict
)
__all__
=
[
'DaskLGBMClassifier'
,
'DaskLGBMRanker'
,
'DaskLGBMRegressor'
,
]
_DaskCollection
=
Union
[
dask_Array
,
dask_DataFrame
,
dask_Series
]
_DaskCollection
=
Union
[
dask_Array
,
dask_DataFrame
,
dask_Series
]
_DaskMatrixLike
=
Union
[
dask_Array
,
dask_DataFrame
]
_DaskMatrixLike
=
Union
[
dask_Array
,
dask_DataFrame
]
_DaskVectorLike
=
Union
[
dask_Array
,
dask_Series
]
_DaskVectorLike
=
Union
[
dask_Array
,
dask_Series
]
...
...
python-package/lightgbm/engine.py
View file @
23403a7c
...
@@ -14,6 +14,13 @@ from .basic import (Booster, Dataset, LightGBMError, _choose_param_value, _Confi
...
@@ -14,6 +14,13 @@ from .basic import (Booster, Dataset, LightGBMError, _choose_param_value, _Confi
_LGBM_CustomObjectiveFunction
,
_log_warning
)
_LGBM_CustomObjectiveFunction
,
_log_warning
)
from
.compat
import
SKLEARN_INSTALLED
,
_LGBMBaseCrossValidator
,
_LGBMGroupKFold
,
_LGBMStratifiedKFold
from
.compat
import
SKLEARN_INSTALLED
,
_LGBMBaseCrossValidator
,
_LGBMGroupKFold
,
_LGBMStratifiedKFold
__all__
=
[
'cv'
,
'CVBooster'
,
'train'
,
]
_LGBM_CustomMetricFunction
=
Callable
[
_LGBM_CustomMetricFunction
=
Callable
[
[
np
.
ndarray
,
Dataset
],
[
np
.
ndarray
,
Dataset
],
Tuple
[
str
,
float
,
bool
]
Tuple
[
str
,
float
,
bool
]
...
...
python-package/lightgbm/libpath.py
View file @
23403a7c
...
@@ -4,6 +4,8 @@ from pathlib import Path
...
@@ -4,6 +4,8 @@ from pathlib import Path
from
platform
import
system
from
platform
import
system
from
typing
import
List
from
typing
import
List
__all__
=
[]
def
find_lib_path
()
->
List
[
str
]:
def
find_lib_path
()
->
List
[
str
]:
"""Find the path to LightGBM library files.
"""Find the path to LightGBM library files.
...
...
python-package/lightgbm/plotting.py
View file @
23403a7c
...
@@ -11,6 +11,14 @@ from .basic import Booster, _data_from_pandas, _is_zero, _log_warning, _MissingT
...
@@ -11,6 +11,14 @@ from .basic import Booster, _data_from_pandas, _is_zero, _log_warning, _MissingT
from
.compat
import
GRAPHVIZ_INSTALLED
,
MATPLOTLIB_INSTALLED
,
pd_DataFrame
from
.compat
import
GRAPHVIZ_INSTALLED
,
MATPLOTLIB_INSTALLED
,
pd_DataFrame
from
.sklearn
import
LGBMModel
from
.sklearn
import
LGBMModel
__all__
=
[
'create_tree_digraph'
,
'plot_importance'
,
'plot_metric'
,
'plot_split_value_histogram'
,
'plot_tree'
,
]
def
_check_not_tuple_of_2_elements
(
obj
:
Any
,
obj_name
:
str
=
'obj'
)
->
None
:
def
_check_not_tuple_of_2_elements
(
obj
:
Any
,
obj_name
:
str
=
'obj'
)
->
None
:
"""Check object is not tuple or does not have 2 elements."""
"""Check object is not tuple or does not have 2 elements."""
...
...
python-package/lightgbm/sklearn.py
View file @
23403a7c
...
@@ -16,6 +16,13 @@ from .compat import (SKLEARN_INSTALLED, LGBMNotFittedError, _LGBMAssertAllFinite
...
@@ -16,6 +16,13 @@ from .compat import (SKLEARN_INSTALLED, LGBMNotFittedError, _LGBMAssertAllFinite
dt_DataTable
,
pd_DataFrame
)
dt_DataTable
,
pd_DataFrame
)
from
.engine
import
train
from
.engine
import
train
__all__
=
[
'LGBMClassifier'
,
'LGBMModel'
,
'LGBMRanker'
,
'LGBMRegressor'
,
]
_LGBM_ScikitCustomObjectiveFunction
=
Union
[
_LGBM_ScikitCustomObjectiveFunction
=
Union
[
Callable
[
Callable
[
[
np
.
ndarray
,
np
.
ndarray
],
[
np
.
ndarray
,
np
.
ndarray
],
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment