:[gddZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZmZmZmZdddddd d e ed e ed e ed e ede ede egeff dZedddeddfdZeddde eeffdZeedddddede dfdZy)z Global configuration for XGBoostN)contextmanager)wraps)AnyCallableDictIteratorOptionalcast)_F)_LIB _check_callc_strpy_str)header extra_note parametersreturnssee_alsorrrrrreturnc ~dddttdtfddtdtffd }|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 valuerc|dS|S)N)rs I/var/www/html/bid-api/venv/lib/python3.12/site-packages/xgboost/config.py none_to_strzconfig_doc..none_to_str\s]r--funccjzzz z_tdtdtdtffd }t t |S)N)rrargskwargsrc|i|SNr)r!r"rs rwrapz6config_doc..config_doc_decorator..wrapjs(( (r)format__doc__rrr r ) rr%common_example doc_templaterrrrrrs ` rconfig_doc_decoratorz(config_doc..config_doc_decorator_s   "6*{:7N  *% &'"  # .)  * (#  $  t ) )s )s )  )B~r)r strr ) rrrrrr*r(r)rs ````` @@@r config_docr, sI0 L)NV.8C=.S.2"" rz# Set global configuration. z Parameters ---------- new_config: Dict[str, Any] Keyword arguments representing the parameters and their values )rr new_configc i}|jD] \}}| |||<tj|}tt j t |yr$)itemsjsondumpsrr XGBSetGlobalConfigr)r-not_nonekvconfigs r set_configr7ssUH  "1 =HQK#ZZ !F''f 67rz9 Get current values of the global configuration. zu Returns ------- args: Dict[str, Any] The list of global parameters and their values )rrctj}ttjtj ||j }|sJtjt|}|Sr$) ctypesc_char_prr XGBGetGlobalConfigbyrefrr0loadsr) config_strrr6s r get_configr?sU"J'' Z(@AB   E L5 ZZu &F Mrz; 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+Ktj}tdi| dtdi|y#tdi|wxYww)Nr)r?copyr7)r- old_configs rconfig_contextrCsA2""$J!  Z  Z s$A7 A AA)r'r9r0 contextlibr functoolsrtypingrrrrr r _typingr corer rrrr+r,r7r?rCrrrrIsD& %@@22 ! $ $!" c SMc  c  c c] c sm c rdBhc L   8S8T8 8    DcN     !.!!$!/0!r