o ٭j@s,dZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZmZmZmZdddddd d e ed e ed e ed e ede ede egeff ddZeddddeddfddZedddde eeffddZeeddddd dede dfd!d"ZdS)#z Global configuration for XGBoostN)contextmanager)wraps)AnyCallableDictIteratorOptionalcast)_F)_LIB _check_callc_strpy_str)header extra_note parametersreturnssee_alsorrrrrreturnc sFdddttdtfdddtdtffdd }|S) aDDecorator 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 a {header} Global configuration consists of a collection of parameters that can be applied in the global scope. See :ref:`global_config` for the full list of parameters supported in the global configuration. {extra_note} .. versionadded:: 1.4.0 af Example ------- .. code-block:: python import xgboost as xgb # Show all messages, including ones pertaining to debugging xgb.set_config(verbosity=2) # Get current value of global configuration # This is a dict containing all parameters in the global configuration, # including 'verbosity' config = xgb.get_config() assert config['verbosity'] == 2 # Example of using the context manager xgb.config_context(). # The context manager will restore the previous value of the global # configuration upon exiting. with xgb.config_context(verbosity=0): # Suppress warning caused by model generated with XGBoost version < 1.0.0 bst = xgb.Booster(model_file='./old_model.bin') assert xgb.get_config()['verbosity'] == 2 # old value restored Nested configuration context is also supported: Example ------- .. code-block:: python with xgb.config_context(verbosity=3): assert xgb.get_config()["verbosity"] == 3 with xgb.config_context(verbosity=2): assert xgb.get_config()["verbosity"] == 2 xgb.set_config(verbosity=2) assert xgb.get_config()["verbosity"] == 2 with xgb.config_context(verbosity=3): assert xgb.get_config()["verbosity"] == 3 valuercSs|durdS|S)N)rrrK/var/www/html/CropPilot/venv/lib/python3.10/site-packages/xgboost/config.py none_to_str]szconfig_doc..none_to_strfunccsdjd_tdtdtdtffdd }tt|S)N)rrargskwargsrcs|i|SNr)rrrrrwrapksz6config_doc..config_doc_decorator..wrap)format__doc__rrr r )rr common_example doc_templaterrrrrrrrconfig_doc_decorator`s   z(config_doc..config_doc_decorator)rstrr )rrrrrr&rr#r config_docs  +$r(z# Set global configuration. z Parameters ---------- new_config: Dict[str, Any] Keyword arguments representing the parameters and their values )rr new_configcKsFi}|D] \}}|dur|||<qt|}ttt|dSr)itemsjsondumpsr r XGBSetGlobalConfigr)r)not_nonekvconfigrrr set_configts  r2z9 Get current values of the global configuration. zu Returns ------- args: Dict[str, Any] The list of global parameters and their values )rrcCs<t}ttt||j}|sJtt |}|Sr) ctypesc_char_pr r XGBGetGlobalConfigbyrefrr+loadsr) config_strrr1rrr get_configs  r9z; Context manager for global XGBoost configuration. z .. note:: All settings, not just those presently modified, will be returned to their previous values when the context manager is exited. This is not thread-safe. z See Also -------- set_config: Set global XGBoost configuration get_config: Get current values of the global configuration )rrrrc ksFt}tdi|z dVWtdi|dStdi|w)Nr)r9copyr2)r) old_configrrrconfig_contexts  "r<)r"r3r+ contextlibr functoolsrtypingrrrrrr _typingr corer r rrr'r(r2r9r<rrrrsX      f