806c92c80b
Co-authored-by: Chengyang Gu <bridgream@gmail.com> Co-authored-by: Jiamingy <jm.yuan@outlook.com>
74 lines
2.0 KiB
Python
74 lines
2.0 KiB
Python
"""Shared typing definition."""
|
|
import ctypes
|
|
import os
|
|
from typing import Any, TypeVar, Union, Type, Sequence, Callable, List, Dict
|
|
|
|
# os.PathLike/string/numpy.array/scipy.sparse/pd.DataFrame/dt.Frame/
|
|
# cudf.DataFrame/cupy.array/dlpack
|
|
import numpy as np
|
|
|
|
DataType = Any
|
|
|
|
# xgboost accepts some other possible types in practice due to historical reason, which is
|
|
# lesser tested. For now we encourage users to pass a simple list of string.
|
|
FeatureInfo = Sequence[str]
|
|
FeatureNames = FeatureInfo
|
|
FeatureTypes = FeatureInfo
|
|
BoosterParam = Union[List, Dict] # better be sequence
|
|
|
|
ArrayLike = Any
|
|
PathLike = Union[str, os.PathLike]
|
|
CupyT = ArrayLike # maybe need a stub for cupy arrays
|
|
NumpyOrCupy = Any
|
|
NumpyDType = Union[str, Type[np.number]]
|
|
PandasDType = Any # real type is pandas.core.dtypes.base.ExtensionDtype
|
|
|
|
FloatCompatible = Union[float, np.float32, np.float64]
|
|
|
|
# callables
|
|
FPreProcCallable = Callable
|
|
|
|
# ctypes
|
|
# c_bst_ulong corresponds to bst_ulong defined in xgboost/c_api.h
|
|
c_bst_ulong = ctypes.c_uint64 # pylint: disable=C0103
|
|
|
|
CTypeT = Union[
|
|
ctypes.c_void_p,
|
|
ctypes.c_char_p,
|
|
ctypes.c_int,
|
|
ctypes.c_float,
|
|
ctypes.c_uint,
|
|
ctypes.c_size_t,
|
|
]
|
|
|
|
# supported numeric types
|
|
CNumeric = Union[
|
|
ctypes.c_float,
|
|
ctypes.c_double,
|
|
ctypes.c_uint,
|
|
ctypes.c_uint64,
|
|
ctypes.c_int32,
|
|
ctypes.c_int64,
|
|
]
|
|
|
|
# c pointer types
|
|
# real type should be, as defined in typeshed
|
|
# but this has to be put in a .pyi file
|
|
# c_str_ptr_t = ctypes.pointer[ctypes.c_char]
|
|
CStrPtr = ctypes.pointer
|
|
# c_str_pptr_t = ctypes.pointer[ctypes.c_char_p]
|
|
CStrPptr = ctypes.pointer
|
|
# c_float_ptr_t = ctypes.pointer[ctypes.c_float]
|
|
CFloatPtr = ctypes.pointer
|
|
|
|
# c_numeric_ptr_t = Union[
|
|
# ctypes.pointer[ctypes.c_float], ctypes.pointer[ctypes.c_double],
|
|
# ctypes.pointer[ctypes.c_uint], ctypes.pointer[ctypes.c_uint64],
|
|
# ctypes.pointer[ctypes.c_int32], ctypes.pointer[ctypes.c_int64]
|
|
# ]
|
|
CNumericPtr = ctypes.pointer
|
|
|
|
# template parameter
|
|
_T = TypeVar("_T")
|
|
_F = TypeVar("_F", bound=Callable[..., Any])
|