




import inspect
import os
import re

from transformers.configuration_utils import PretrainedConfig
from transformers.utils import direct_transformers_import


# All paths are set with the intent you should run this script from the root of the repo with the command
# python utils/check_config_docstrings.py
a__		     =     '''src/transformers'''


# This is to make sure the transformers module imported is the one in the repo.
a__		     =     direct_transformers_import(PATH_TO_TRANSFORMERS)

a__		     =     transformers.models.auto.configuration_auto.CONFIG_MAPPING

a__		     =     {
    # used to compute the property `self.chunk_length`
    '''EncodecConfig''': ['''overlap'''],
    # used as `self.bert_model = BertModel(config, ...)`
    '''DPRConfig''': True,
    # not used in modeling files, but it's an important information
    '''FSMTConfig''': ['''langs'''],
    # used internally in the configuration class file
    '''GPTNeoConfig''': ['''attention_types'''],
    # used internally in the configuration class file
    '''EsmConfig''': ['''is_folding_model'''],
    # used during training (despite we don't have training script for these models yet)
    '''Mask2FormerConfig''': ['''ignore_value'''],
    # `ignore_value` used during training (despite we don't have training script for these models yet)
    # `norm` used in conversion script (despite not using in the modeling file)
    '''OneFormerConfig''': ['''ignore_value''', '''norm'''],
    # used during preprocessing and collation, see `collating_graphormer.py`
    '''GraphormerConfig''': ['''spatial_pos_max'''],
    # used internally in the configuration class file
    '''T5Config''': ['''feed_forward_proj'''],
    # used internally in the configuration class file
    # `tokenizer_class` get default value `T5Tokenizer` intentionally
    '''MT5Config''': ['''feed_forward_proj''', '''tokenizer_class'''],
    '''UMT5Config''': ['''feed_forward_proj''', '''tokenizer_class'''],
    # used internally in the configuration class file
    '''LongT5Config''': ['''feed_forward_proj'''],
    # used internally in the configuration class file
    '''SwitchTransformersConfig''': ['''feed_forward_proj'''],
    # having default values other than `1e-5` - we can't fix them without breaking
    '''BioGptConfig''': ['''layer_norm_eps'''],
    # having default values other than `1e-5` - we can't fix them without breaking
    '''GLPNConfig''': ['''layer_norm_eps'''],
    # having default values other than `1e-5` - we can't fix them without breaking
    '''SegformerConfig''': ['''layer_norm_eps'''],
    # having default values other than `1e-5` - we can't fix them without breaking
    '''CvtConfig''': ['''layer_norm_eps'''],
    # having default values other than `1e-5` - we can't fix them without breaking
    '''PerceiverConfig''': ['''layer_norm_eps'''],
    # used internally to calculate the feature size
    '''InformerConfig''': ['''num_static_real_features''', '''num_time_features'''],
    # used internally to calculate the feature size
    '''TimeSeriesTransformerConfig''': ['''num_static_real_features''', '''num_time_features'''],
    # used internally to calculate the feature size
    '''AutoformerConfig''': ['''num_static_real_features''', '''num_time_features'''],
    # used internally to calculate `mlp_dim`
    '''SamVisionConfig''': ['''mlp_ratio'''],
    # For (head) training, but so far not implemented
    '''ClapAudioConfig''': ['''num_classes'''],
    # Not used, but providing useful information to users
    '''SpeechT5HifiGanConfig''': ['''sampling_rate'''],
}


# TODO (ydshieh): Check the failing cases, try to fix them or move some cases to the above block once we are sure
SPECIAL_CASES_TO_ALLOW.update(
    {
        '''CLIPSegConfig''': True,
        '''DeformableDetrConfig''': True,
        '''DetaConfig''': True,
        '''DinatConfig''': True,
        '''DonutSwinConfig''': True,
        '''EfficientFormerConfig''': True,
        '''FSMTConfig''': True,
        '''JukeboxConfig''': True,
        '''LayoutLMv2Config''': True,
        '''MaskFormerSwinConfig''': True,
        '''MT5Config''': True,
        '''NatConfig''': True,
        '''OneFormerConfig''': True,
        '''PerceiverConfig''': True,
        '''RagConfig''': True,
        '''SpeechT5Config''': True,
        '''SwinConfig''': True,
        '''Swin2SRConfig''': True,
        '''Swinv2Config''': True,
        '''SwitchTransformersConfig''': True,
        '''TableTransformerConfig''': True,
        '''TapasConfig''': True,
        '''TransfoXLConfig''': True,
        '''UniSpeechConfig''': True,
        '''UniSpeechSatConfig''': True,
        '''WavLMConfig''': True,
        '''WhisperConfig''': True,
        # TODO: @Arthur (for `alignment_head` and `alignment_layer`)
        '''JukeboxPriorConfig''': True,
        # TODO: @Younes (for `is_decoder`)
        '''Pix2StructTextConfig''': True,
    }
)





def 				A__ (snake_case   :		str		,	snake_case   :		int		,	snake_case   :		Optional[Any]		,	snake_case   :		Optional[Any]				)     ->						Any:
					__UpperCamelCase					:	Any             =      False
					for attribute in attributes:
										for modeling_source in source_strings:
															# check if we can find `config.xxx`, `getattr(config, "xxx", ...)` or `getattr(self.config, "xxx", ...)`
															if (
															    F'''config.{attribute}''' in modeling_source
															    or F'''getattr(config, "{attribute}"''' in modeling_source
															    or F'''getattr(self.config, "{attribute}"''' in modeling_source
															):
																				__UpperCamelCase					:	str             =      True
															# Deal with multi-line cases
															elif (
															    re.search(
															        rF'''getattr[ \t\v\n\r\f]*\([ \t\v\n\r\f]*(self\.)?config,[ \t\v\n\r\f]*"{attribute}"'''		,	snake_case		,	)
															    is not None
															):
																				__UpperCamelCase					:	Optional[int]             =      True
															# `SequenceSummary` is called with `SequenceSummary(config)`
															elif attribute in [
															    "summary_type",
															    "summary_use_proj",
															    "summary_activation",
															    "summary_last_dropout",
															    "summary_proj_to_labels",
															    "summary_first_dropout",
															]:
																				if "SequenceSummary" in modeling_source:
																									__UpperCamelCase					:	Optional[Any]             =      True
															if attribute_used:
																				break
										if attribute_used:
															break

    # common and important attributes, even if they do not always appear in the modeling files
					__UpperCamelCase					:	Any             =      [
					    """bos_index""",
					    """eos_index""",
					    """pad_index""",
					    """unk_index""",
					    """mask_index""",
					    """image_size""",
					    """use_cache""",
					    """out_features""",
					    """out_indices""",
					]
					__UpperCamelCase					:	str             =      ["""encoder_no_repeat_ngram_size"""]

					# Special cases to be allowed
					__UpperCamelCase					:	str             =      True
					if not attribute_used:
										__UpperCamelCase					:	Optional[Any]             =      False
										for attribute in attributes:
															# Allow if the default value in the configuration class is different from the one in `PretrainedConfig`
															if attribute in ["is_encoder_decoder"] and default_value is True:
																				__UpperCamelCase					:	Optional[int]             =      True
															elif attribute in ["tie_word_embeddings"] and default_value is False:
																				__UpperCamelCase					:	List[str]             =      True

															# Allow cases without checking the default value in the configuration class
															elif attribute in attributes_to_allow + attributes_used_in_generation:
																				__UpperCamelCase					:	Optional[Any]             =      True
															elif attribute.endswith("""_token_id"""				):
																				__UpperCamelCase					:	int             =      True

															# configuration class specific cases
															if not case_allowed:
																				__UpperCamelCase					:	Tuple             =      SPECIAL_CASES_TO_ALLOW.get(config_class.__name__		,	[]				)
																				__UpperCamelCase					:	int             =      allowed_cases is True or attribute in allowed_cases

					return attribute_used or case_allowed





def 				A__ (snake_case   :		List[Any]				)     ->						Dict:
					__UpperCamelCase					:	Optional[Any]             =      dict(inspect.signature(config_class.__init__				).parameters				)
					__UpperCamelCase					:	Optional[Any]             =      [x for x in list(signature.keys()				) if x not in ["""self""", """kwargs"""]]
					__UpperCamelCase					:	str             =      [signature[param].default for param in parameter_names]

					# If `attribute_map` exists, an attribute can have different names to be used in the modeling files, and as long
					# as one variant is used, the test should pass
					__UpperCamelCase					:	Dict             =      {}
					if len(config_class.attribute_map				) > 0:
										__UpperCamelCase					:	Dict             =      {v: k for k, v in config_class.attribute_map.items()}

					# Get the path to modeling source files
					__UpperCamelCase					:	List[Any]             =      inspect.getsourcefile(snake_case				)
					__UpperCamelCase					:	List[Any]             =      os.path.dirname(snake_case				)
					# Let's check against all frameworks: as long as one framework uses an attribute, we are good.
					__UpperCamelCase					:	List[Any]             =      [os.path.join(snake_case		,	snake_case				) for fn in os.listdir(snake_case				) if fn.startswith("""modeling_"""				)]

					# Get the source code strings
					__UpperCamelCase					:	Any             =      []
					for path in modeling_paths:
										if os.path.isfile(snake_case				):
															with open(snake_case				) as fp:
																				modeling_sources.append(fp.read()				)

					__UpperCamelCase					:	List[str]             =      []
					for config_param, default_value in zip(snake_case		,	snake_case				):
										# `attributes` here is all the variant names for `config_param`
										__UpperCamelCase					:	str             =      [config_param]
										# some configuration classes have non-empty `attribute_map`, and both names could be used in the
										# corresponding modeling files. As long as one of them appears, it is fine.
										if config_param in reversed_attribute_map:
															attributes.append(reversed_attribute_map[config_param]				)

										if not check_attribute_being_used(snake_case		,	snake_case		,	snake_case		,	snake_case				):
															unused_attributes.append(attributes[0]				)

					return sorted(snake_case				)





def 				A__ ()     ->						Dict:
					__UpperCamelCase					:	Dict             =      {}
					for _config_class in list(CONFIG_MAPPING.values()				):
										# Skip deprecated models
										if "models.deprecated" in _config_class.__module__:
															continue
										# Some config classes are not in `CONFIG_MAPPING` (e.g. `CLIPVisionConfig`, `Blip2VisionConfig`, etc.)
										__UpperCamelCase					:	Tuple             =      [
										    cls
										    for name, cls in inspect.getmembers(
										        inspect.getmodule(_config_class				)		,	lambda snake_case				: inspect.isclass(snake_case				)
										        and issubclass(snake_case		,	snake_case				)
										        and inspect.getmodule(snake_case				) == inspect.getmodule(_config_class				)		,	)
										]
										for config_class in config_classes_in_module:
															__UpperCamelCase					:	List[str]             =      check_config_attributes_being_used(snake_case				)
															if len(snake_case				) > 0:
																				__UpperCamelCase					:	List[Any]             =      unused_attributes

					if len(snake_case				) > 0:
										__UpperCamelCase					:	str             =      """The following configuration classes contain unused attributes in the corresponding modeling files:\n"""
										for name, attributes in configs_with_unused_attributes.items():
															error += F'''{name}: {attributes}\n'''

										raise ValueError(snake_case				)


if __name__ == "__main__":
	check_config_attributes()












import math
from enum import Enum
from typing import Optional, Union

from torch.optim import Optimizer
from torch.optim.lr_scheduler import LambdaLR

from .utils import logging


a__		     =     logging.get_logger(__name__)


class    SCREAMING_SNAKE_CASE_				(       _UpperCamelCase   ):



	"""simple docstring"""


	__magic_name__   :       Dict      	=		'linear'
	__magic_name__   :       Dict      	=		'cosine'
	__magic_name__   :       Optional[int]      	=		'cosine_with_restarts'
	__magic_name__   :       List[str]      	=		'polynomial'
	__magic_name__   :       Any      	=		'constant'
	__magic_name__   :       Union[str, Any]      	=		'constant_with_warmup'
	__magic_name__   :       str      	=		'piecewise_constant'






def 				A__ (snake_case   :		Optimizer		,	snake_case   :		int = -1				)     ->						Optional[Any]:
					return LambdaLR(snake_case		,	lambda snake_case				: 1		,	last_epoch=snake_case				)





def 				A__ (snake_case   :		Optimizer		,	snake_case   :		int		,	snake_case   :		int = -1				)     ->						List[Any]:

					def lr_lambda(snake_case   :		int				):
										if current_step < num_warmup_steps:
															return float(snake_case				) / float(max(1.0		,	snake_case				)				)
										return 1.0

					return LambdaLR(snake_case		,	snake_case		,	last_epoch=snake_case				)





def 				A__ (snake_case   :		Optimizer		,	snake_case   :		str		,	snake_case   :		int = -1				)     ->						Union[str, Any]:
					__UpperCamelCase					:	Optional[Any]             =      {}
					__UpperCamelCase					:	int             =      step_rules.split(""","""				)
					for rule_str in rule_list[:-1]:
										__UpperCamelCase      ,			__UpperCamelCase					:	Tuple             =      rule_str.split(""":"""				)
										__UpperCamelCase					:	int             =      int(snake_case				)
										__UpperCamelCase					:	Union[str, Any]             =      float(snake_case				)
										__UpperCamelCase					:	Optional[int]             =      value
					__UpperCamelCase					:	Dict             =      float(rule_list[-1]				)

					def create_rules_function(snake_case   :		List[str]		,	snake_case   :		Any				):
										def rule_func(snake_case   :		int				) -> float:
															__UpperCamelCase					:	Any             =      sorted(rules_dict.keys()				)
															for i, sorted_step in enumerate(snake_case				):
																				if steps < sorted_step:
																									return rules_dict[sorted_steps[i]]
															return last_lr_multiple

										return rule_func

					__UpperCamelCase					:	Tuple             =      create_rules_function(snake_case		,	snake_case				)

					return LambdaLR(snake_case		,	snake_case		,	last_epoch=snake_case				)





def 				A__ (snake_case   :		int		,	snake_case   :		Optional[Any]		,	snake_case   :		Union[str, Any]		,	snake_case   :		str=-1				)     ->						str:

					def lr_lambda(snake_case   :		int				):
										if current_step < num_warmup_steps:
															return float(snake_case				) / float(max(1		,	snake_case				)				)
										return max(
										    0.0		,	float(num_training_steps - current_step				) / float(max(1		,	num_training_steps - num_warmup_steps				)				)				)

					return LambdaLR(snake_case		,	snake_case		,	snake_case				)





def 				A__ (snake_case   :		Optimizer		,	snake_case   :		int		,	snake_case   :		int		,	snake_case   :		float = 0.5		,	snake_case   :		int = -1				)     ->						List[str]:

					def lr_lambda(snake_case   :		Dict				):
										if current_step < num_warmup_steps:
															return float(snake_case				) / float(max(1		,	snake_case				)				)
										__UpperCamelCase					:	Dict             =      float(current_step - num_warmup_steps				) / float(max(1		,	num_training_steps - num_warmup_steps				)				)
										return max(0.0		,	0.5 * (1.0 + math.cos(math.pi * float(snake_case				) * 2.0 * progress				))				)

					return LambdaLR(snake_case		,	snake_case		,	snake_case				)





def 				A__ (snake_case   :		Optimizer		,	snake_case   :		int		,	snake_case   :		int		,	snake_case   :		int = 1		,	snake_case   :		int = -1				)     ->						Tuple:

					def lr_lambda(snake_case   :		Optional[int]				):
										if current_step < num_warmup_steps:
															return float(snake_case				) / float(max(1		,	snake_case				)				)
										__UpperCamelCase					:	List[str]             =      float(current_step - num_warmup_steps				) / float(max(1		,	num_training_steps - num_warmup_steps				)				)
										if progress >= 1.0:
															return 0.0
										return max(0.0		,	0.5 * (1.0 + math.cos(math.pi * ((float(snake_case				) * progress) % 1.0)				))				)

					return LambdaLR(snake_case		,	snake_case		,	snake_case				)





def 				A__ (snake_case   :		List[str]		,	snake_case   :		Optional[Any]		,	snake_case   :		Optional[int]		,	snake_case   :		str=1e-7		,	snake_case   :		List[str]=1.0		,	snake_case   :		Dict=-1				)     ->						Tuple:
					__UpperCamelCase					:	Tuple             =      optimizer.defaults["""lr"""]
					if not (lr_init > lr_end):
										raise ValueError(F'''lr_end ({lr_end}) must be be smaller than initial lr ({lr_init})'''				)

					def lr_lambda(snake_case   :		int				):
										if current_step < num_warmup_steps:
															return float(snake_case				) / float(max(1		,	snake_case				)				)
										elif current_step > num_training_steps:
															return lr_end / lr_init  # as LambdaLR multiplies by lr_init
										else:
															__UpperCamelCase					:	List[str]             =      lr_init - lr_end
															__UpperCamelCase					:	Any             =      num_training_steps - num_warmup_steps
															__UpperCamelCase					:	List[str]             =      1 - (current_step - num_warmup_steps) / decay_steps
															__UpperCamelCase					:	List[Any]             =      lr_range * pct_remaining**power + lr_end
															return decay / lr_init  # as LambdaLR multiplies by lr_init

					return LambdaLR(snake_case		,	snake_case		,	snake_case				)


a__		     =     {
    SchedulerType.LINEAR: get_linear_schedule_with_warmup,
    SchedulerType.COSINE: get_cosine_schedule_with_warmup,
    SchedulerType.COSINE_WITH_RESTARTS: get_cosine_with_hard_restarts_schedule_with_warmup,
    SchedulerType.POLYNOMIAL: get_polynomial_decay_schedule_with_warmup,
    SchedulerType.CONSTANT: get_constant_schedule,
    SchedulerType.CONSTANT_WITH_WARMUP: get_constant_schedule_with_warmup,
    SchedulerType.PIECEWISE_CONSTANT: get_piecewise_constant_schedule,
}







def 				A__ (snake_case   :		Union[str, SchedulerType]		,	snake_case   :		Optimizer		,	snake_case   :		Optional[str] = None		,	snake_case   :		Optional[int] = None		,	snake_case   :		Optional[int] = None		,	snake_case   :		int = 1		,	snake_case   :		float = 1.0		,	snake_case   :		int = -1		,	)     ->						Dict:
					__UpperCamelCase					:	List[str]             =      SchedulerType(snake_case				)
					__UpperCamelCase					:	int             =      TYPE_TO_SCHEDULER_FUNCTION[name]
					if name == SchedulerType.CONSTANT:
										return schedule_func(snake_case		,	last_epoch=snake_case				)

					if name == SchedulerType.PIECEWISE_CONSTANT:
										return schedule_func(snake_case		,	step_rules=snake_case		,	last_epoch=snake_case				)

					# All other schedulers require `num_warmup_steps`
					if num_warmup_steps is None:
										raise ValueError(F'''{name} requires `num_warmup_steps`, please provide that argument.'''				)

					if name == SchedulerType.CONSTANT_WITH_WARMUP:
										return schedule_func(snake_case		,	num_warmup_steps=snake_case		,	last_epoch=snake_case				)

					# All other schedulers require `num_training_steps`
					if num_training_steps is None:
										raise ValueError(F'''{name} requires `num_training_steps`, please provide that argument.'''				)

					if name == SchedulerType.COSINE_WITH_RESTARTS:
										return schedule_func(
										    snake_case		,	num_warmup_steps=snake_case		,	num_training_steps=snake_case		,	num_cycles=snake_case		,	last_epoch=snake_case		,	)

					if name == SchedulerType.POLYNOMIAL:
										return schedule_func(
										    snake_case		,	num_warmup_steps=snake_case		,	num_training_steps=snake_case		,	power=snake_case		,	last_epoch=snake_case		,	)

					return schedule_func(
					    snake_case		,	num_warmup_steps=snake_case		,	num_training_steps=snake_case		,	last_epoch=snake_case				)






