Medial Code Documentation
Loading...
Searching...
No Matches
Functions
xgboost.config Namespace Reference

Functions

Callable[[_F], _F] config_doc (*Optional[str] header=None, Optional[str] extra_note=None, Optional[str] parameters=None, Optional[str] returns=None, Optional[str] see_also=None)
 
None set_config (**Any new_config)
 
Dict[str, Any] get_config ()
 
Iterator[None] config_context (**Any new_config)
 

Detailed Description

Global configuration for XGBoost

Function Documentation

◆ config_doc()

Callable[[_F], _F] xgboost.config.config_doc ( *Optional[str]   header = None,
Optional[str]   extra_note = None,
Optional[str]   parameters = None,
Optional[str]   returns = None,
Optional[str]   see_also = None 
)
Decorator to format docstring for config functions.

Parameters
----------
header: str
    An introducion to the function
extra_note: str
    Additional notes
parameters: str
    Parameters of the function
returns: str
    Return value
see_also: str
    Related functions