o il@sdZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z ddlmZddlmZmZdd lmZmZmZmZmZmZmZmZmZd d lmZmZm Z ercdd l!m"Z"e#e$Z%e d Z&e'e e(e dfe e(e dffZ)dZ*dZ+dZ,dZ-dZ.ddZ/GdddZ0Gddde0Z1d(de2fddZ3d)de2de2fddZ4d d!Z5d"d#Z6d$d%Z7Gd&d'd'ee(ee)fZ8d!gZ9dS)*z-Factory function to build auto-model classes.N) OrderedDict)Iterator)AnyTypeVarUnion)PretrainedConfig)get_class_from_dynamic_moduleresolve_trust_remote_code) CONFIG_NAME cached_file copy_funcextract_commit_hashfind_adapter_config_fileis_peft_availableis_torch_availableloggingrequires_backends) AutoConfigmodel_type_to_module_name!replace_list_option_in_docstrings)GenerationMixin_TaJ This is a generic model class that will be instantiated as one of the model classes of the library when created with the [`~BaseAutoModelClass.from_pretrained`] class method or the [`~BaseAutoModelClass.from_config`] class method. This class cannot be instantiated directly using `__init__()` (throws an error). ax Instantiates one of the model classes of the library from a configuration. Note: Loading a model from its configuration file does **not** load the model weights. It only affects the model's configuration. Use [`~BaseAutoModelClass.from_pretrained`] to load the model weights. Args: config ([`PretrainedConfig`]): The model class to instantiate is selected based on the configuration class: List options attn_implementation (`str`, *optional*): The attention implementation to use in the model (if relevant). Can be any of `"eager"` (manual implementation of the attention), `"sdpa"` (using [`F.scaled_dot_product_attention`](https://pytorch.org/docs/master/generated/torch.nn.functional.scaled_dot_product_attention.html)), or `"flash_attention_2"` (using [Dao-AILab/flash-attention](https://github.com/Dao-AILab/flash-attention)). By default, if available, SDPA will be used for torch>=2.1.1. The default is otherwise the manual `"eager"` implementation. Examples: ```python >>> from transformers import AutoConfig, BaseAutoModelClass >>> # Download configuration from huggingface.co and cache. >>> config = AutoConfig.from_pretrained("checkpoint_placeholder") >>> model = BaseAutoModelClass.from_config(config) ``` ac Instantiate one of the model classes of the library from a pretrained model. The model class to instantiate is selected based on the `model_type` property of the config object (either passed as an argument or loaded from `pretrained_model_name_or_path` if possible), or when it's missing, by falling back to using pattern matching on `pretrained_model_name_or_path`: List options The model is set in evaluation mode by default using `model.eval()` (so for instance, dropout modules are deactivated). To train the model, you should first set it back in training mode with `model.train()` Args: pretrained_model_name_or_path (`str` or `os.PathLike`): Can be either: - A string, the *model id* of a pretrained model hosted inside a model repo on huggingface.co. - A path to a *directory* containing model weights saved using [`~PreTrainedModel.save_pretrained`], e.g., `./my_model_directory/`. - A path or url to a *tensorflow index checkpoint file* (e.g, `./tf_model/model.ckpt.index`). In this case, `from_tf` should be set to `True` and a configuration object should be provided as `config` argument. This loading path is slower than converting the TensorFlow checkpoint in a PyTorch model using the provided conversion scripts and loading the PyTorch model afterwards. model_args (additional positional arguments, *optional*): Will be passed along to the underlying model `__init__()` method. config ([`PretrainedConfig`], *optional*): Configuration for the model to use instead of an automatically loaded configuration. Configuration can be automatically loaded when: - The model is a model provided by the library (loaded with the *model id* string of a pretrained model). - The model was saved using [`~PreTrainedModel.save_pretrained`] and is reloaded by supplying the save directory. - The model is loaded by supplying a local directory as `pretrained_model_name_or_path` and a configuration JSON file named *config.json* is found in the directory. state_dict (*dict[str, torch.Tensor]*, *optional*): A state dictionary to use instead of a state dictionary loaded from saved weights file. This option can be used if you want to create a model from a pretrained configuration but load your own weights. In this case though, you should check if using [`~PreTrainedModel.save_pretrained`] and [`~PreTrainedModel.from_pretrained`] is not a simpler option. cache_dir (`str` or `os.PathLike`, *optional*): Path to a directory in which a downloaded pretrained model configuration should be cached if the standard cache should not be used. from_tf (`bool`, *optional*, defaults to `False`): Load the model weights from a TensorFlow checkpoint save file (see docstring of `pretrained_model_name_or_path` argument). force_download (`bool`, *optional*, defaults to `False`): Whether or not to force the (re-)download of the model weights and configuration files, overriding the cached versions if they exist. resume_download: Deprecated and ignored. All downloads are now resumed by default when possible. Will be removed in v5 of Transformers. proxies (`dict[str, str]`, *optional*): A dictionary of proxy servers to use by protocol or endpoint, e.g., `{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}`. The proxies are used on each request. output_loading_info(`bool`, *optional*, defaults to `False`): Whether ot not to also return a dictionary containing missing keys, unexpected keys and error messages. local_files_only(`bool`, *optional*, defaults to `False`): Whether or not to only look at local files (e.g., not try downloading the model). revision (`str`, *optional*, defaults to `"main"`): The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any identifier allowed by git. trust_remote_code (`bool`, *optional*, defaults to `False`): Whether or not to allow for custom models defined on the Hub in their own modeling files. This option should only be set to `True` for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine. code_revision (`str`, *optional*, defaults to `"main"`): The specific revision to use for the code on the Hub, if the code leaves in a different repository than the rest of the model. It can be a branch name, a tag name, or a commit id, since we use a git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any identifier allowed by git. kwargs (additional keyword arguments, *optional*): Can be used to update the configuration object (after it being loaded) and initiate the model (e.g., `output_attentions=True`). Behaves differently depending on whether a `config` is provided or automatically loaded: - If a configuration is provided with `config`, `**kwargs` will be directly passed to the underlying model's `__init__` method (we assume all relevant updates to the configuration have already been done) - If a configuration is not provided, `kwargs` will be first passed to the configuration class initialization function ([`~PretrainedConfig.from_pretrained`]). Each key of `kwargs` that corresponds to a configuration attribute will be used to override said attribute with the supplied `kwargs` value. Remaining keys that do not correspond to any configuration attribute will be passed to the underlying model's `__init__` function. Examples: ```python >>> from transformers import AutoConfig, BaseAutoModelClass >>> # Download model and configuration from huggingface.co and cache. >>> model = BaseAutoModelClass.from_pretrained("checkpoint_placeholder") >>> # Update configuration during loading >>> model = BaseAutoModelClass.from_pretrained("checkpoint_placeholder", output_attentions=True) >>> model.config.output_attentions True >>> # Loading from a TF checkpoint file instead of a PyTorch model (slower) >>> config = AutoConfig.from_pretrained("./tf_model/shortcut_placeholder_tf_model_config.json") >>> model = BaseAutoModelClass.from_pretrained( ... "./tf_model/shortcut_placeholder_tf_checkpoint.ckpt.index", from_tf=True, config=config ... ) ``` a Instantiate one of the model classes of the library from a pretrained model. The model class to instantiate is selected based on the `model_type` property of the config object (either passed as an argument or loaded from `pretrained_model_name_or_path` if possible), or when it's missing, by falling back to using pattern matching on `pretrained_model_name_or_path`: List options Args: pretrained_model_name_or_path (`str` or `os.PathLike`): Can be either: - A string, the *model id* of a pretrained model hosted inside a model repo on huggingface.co. - A path to a *directory* containing model weights saved using [`~PreTrainedModel.save_pretrained`], e.g., `./my_model_directory/`. - A path or url to a *PyTorch state_dict save file* (e.g, `./pt_model/pytorch_model.bin`). In this case, `from_pt` should be set to `True` and a configuration object should be provided as `config` argument. This loading path is slower than converting the PyTorch model in a TensorFlow model using the provided conversion scripts and loading the TensorFlow model afterwards. model_args (additional positional arguments, *optional*): Will be passed along to the underlying model `__init__()` method. config ([`PretrainedConfig`], *optional*): Configuration for the model to use instead of an automatically loaded configuration. Configuration can be automatically loaded when: - The model is a model provided by the library (loaded with the *model id* string of a pretrained model). - The model was saved using [`~PreTrainedModel.save_pretrained`] and is reloaded by supplying the save directory. - The model is loaded by supplying a local directory as `pretrained_model_name_or_path` and a configuration JSON file named *config.json* is found in the directory. cache_dir (`str` or `os.PathLike`, *optional*): Path to a directory in which a downloaded pretrained model configuration should be cached if the standard cache should not be used. from_pt (`bool`, *optional*, defaults to `False`): Load the model weights from a PyTorch checkpoint save file (see docstring of `pretrained_model_name_or_path` argument). force_download (`bool`, *optional*, defaults to `False`): Whether or not to force the (re-)download of the model weights and configuration files, overriding the cached versions if they exist. resume_download: Deprecated and ignored. All downloads are now resumed by default when possible. Will be removed in v5 of Transformers. proxies (`dict[str, str]`, *optional*): A dictionary of proxy servers to use by protocol or endpoint, e.g., `{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}`. The proxies are used on each request. output_loading_info(`bool`, *optional*, defaults to `False`): Whether ot not to also return a dictionary containing missing keys, unexpected keys and error messages. local_files_only(`bool`, *optional*, defaults to `False`): Whether or not to only look at local files (e.g., not try downloading the model). revision (`str`, *optional*, defaults to `"main"`): The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any identifier allowed by git. trust_remote_code (`bool`, *optional*, defaults to `False`): Whether or not to allow for custom models defined on the Hub in their own modeling files. This option should only be set to `True` for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine. code_revision (`str`, *optional*, defaults to `"main"`): The specific revision to use for the code on the Hub, if the code leaves in a different repository than the rest of the model. It can be a branch name, a tag name, or a commit id, since we use a git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any identifier allowed by git. kwargs (additional keyword arguments, *optional*): Can be used to update the configuration object (after it being loaded) and initiate the model (e.g., `output_attentions=True`). Behaves differently depending on whether a `config` is provided or automatically loaded: - If a configuration is provided with `config`, `**kwargs` will be directly passed to the underlying model's `__init__` method (we assume all relevant updates to the configuration have already been done) - If a configuration is not provided, `kwargs` will be first passed to the configuration class initialization function ([`~PretrainedConfig.from_pretrained`]). Each key of `kwargs` that corresponds to a configuration attribute will be used to override said attribute with the supplied `kwargs` value. Remaining keys that do not correspond to any configuration attribute will be passed to the underlying model's `__init__` function. Examples: ```python >>> from transformers import AutoConfig, BaseAutoModelClass >>> # Download model and configuration from huggingface.co and cache. >>> model = BaseAutoModelClass.from_pretrained("checkpoint_placeholder") >>> # Update configuration during loading >>> model = BaseAutoModelClass.from_pretrained("checkpoint_placeholder", output_attentions=True) >>> model.config.output_attentions True >>> # Loading from a PyTorch checkpoint file instead of a TensorFlow model (slower) >>> config = AutoConfig.from_pretrained("./pt_model/shortcut_placeholder_pt_model_config.json") >>> model = BaseAutoModelClass.from_pretrained( ... "./pt_model/shortcut_placeholder_pytorch_model.bin", from_pt=True, config=config ... ) ``` cCs|t|}t|ttfs|Sdd|D}t|dg}|D],}||vr*||Sd||vr:|d|Sd||vrJ|d|Sq|dS)NcSsi|]}|j|qS__name__).0modelrrY/home/ubuntu/.local/lib/python3.10/site-packages/transformers/models/auto/auto_factory.py sz$_get_model_class.. architecturesTFFlaxr)type isinstancelisttuplegetattr)config model_mappingsupported_models name_to_modelr!archrrr_get_model_classs   r.c@sleZdZdZdddZeddZededefdd Zed e e e j e ffd d Z eddddZdS)_BaseAutoModelClassNreturncOs&t|jjd|jjd|jjd)Nz+ is designed to be instantiated using the `z5.from_pretrained(pretrained_model_name_or_path)` or `z.from_config(config)` methods.)OSError __class__r)selfargskwargsrrr__init__s z_BaseAutoModelClass.__init__c KsN|dd}t|do|j|jv}t||jv}|r8|j|j}d|vr,|dd}nd}t||j|||d}|rx|rxd|vrH|d\}}n|j }t ||fi|} |se|j |j | dd| j |d|d d} t| } | j|fi|St||jvrt||j} | j|fi|Std |j d |jd d dd|jDd)Ntrust_remote_codeauto_map--r upstream_repoTexist_ok auto_class code_revision!Unrecognized configuration class  for this kind of AutoModel: . Model type should be one of , cs|]}|jVqdSNrrcrrr z2_BaseAutoModelClass.from_config...)pophasattrrr8r$_model_mappingsplitr _name_or_path name_or_pathr registerr2register_for_auto_class$add_generation_mixin_to_remote_model _from_configr. ValueErrorjoin) clsr)r5r7has_remote_codehas_local_code class_refr;repo_id model_class_rrr from_configs<      z_BaseAutoModelClass.from_configr)cCs|S)z`Additional autoclass-specific config post-loading manipulation. May be overridden in subclasses.r)rXr)rrr_prepare_config_for_auto_classsz2_BaseAutoModelClass._prepare_config_for_auto_classpretrained_model_name_or_pathc sdd}d}dd<gd}fdd|D}dd}d d} d d} |d d} |d d} | durNtd t| durLtd| } | durV| |d <| durxt|tsrt|t fdddd|} t | | } nt |d d} t r| duri} | dur| | d <t |fd | i| }|durt|ddd}t|}|| d<|d}Wdn1swYt|ts$t}ddkr҈d}ddkrވd}ddurd}tj|fd|| d|\}|dddkrdd<|dddkrdd<|dddur$|dd<t|do/|j|jv}t||jv}d}|rN|j|j}d|vrN|dd}t|||||d}|d<| d <|r|rt||fd|i|}|dd}|s|j|j|dd|j|d t |}|j|g|Rd|i|St||jvrt!||j}|j"|j#d!dkr|$}|j|g|Rd|i|Std"|jd#|jd$d%%d&d'|jDd())Nr)r7T _from_auto) cache_dirforce_downloadlocal_files_onlyproxiesresume_downloadrevision subfolderuse_auth_tokentokencs i|] }|vr||qSr)rL)rnamer5rrr s z7_BaseAutoModelClass.from_pretrained..r@ _commit_hashadapter_kwargsrkrjzrThe `use_auth_token` argument is deprecated and will be removed in v5 of Transformers. Please use `token` instead.zV`token` and `use_auth_token` are both specified. Please set only the argument `token`.F) _raise_exceptions_for_gated_repo%_raise_exceptions_for_missing_entries'_raise_exceptions_for_connection_errorsrzutf-8)encoding_adapter_model_pathbase_model_name_or_path torch_dtypeautodtypequantization_config)return_unused_kwargsr@rnr8r9rr:r<r> text_configrArBrCrDcsrErFrrGrrrrIarJz6_BaseAutoModelClass.from_pretrained..rK)&rLgetwarningswarn FutureWarningrVr%rr r rr(rropenjsonloadcopydeepcopyrfrom_pretrainedrMrr8r$rNrOr r rRr2rSrTr. config_class sub_configsget_text_configrW)rXra model_argsr5r)r7hub_kwargs_names hub_kwargsr@ commit_hashrorkrjresolved_config_filemaybe_adapter_pathfadapter_config kwargs_origr^rYrZr;r[r]rrmrrs                          z#_BaseAutoModelClass.from_pretrainedFcCsFt|dr|jj|jkrtd|jd|d|jj|||ddS)a Register a new model for this class. Args: config_class ([`PretrainedConfig`]): The configuration corresponding to the model to register. model_class ([`PreTrainedModel`]): The model to register. rzThe model class you are passing has a `config_class` attribute that is not consistent with the config class you passed (model has z and you passed z!. Fix one of those so they match!r<N)rMrrrVrNrR)rXrr]r=rrrrRds z_BaseAutoModelClass.registerr0NF)r __module__ __qualname__rNr6 classmethodr_rr`rstrosPathLikerrRrrrrr/s  &r/cs4eZdZdZefddZefddZZS)_BaseAutoBackboneClassNc st|ddgddlm}|d|}|ddurtd|dd r)td |d |j}|d |j}|d |j}|d|j } |||||| d}t j |fi|S)Nvisiontimmr)TimmBackboneConfigr) out_featuresz0Cannot specify `out_features` for timm backbonesoutput_loading_infoFz@Cannot specify `output_loading_info=True` when loading from timm num_channels features_onlyuse_pretrained_backbone out_indices)backbonerrrr) rmodels.timm_backbonerrLr}rVrrrrsuperr_) rXrarr5rr)rrrrr2rr#_load_timm_backbone_from_pretrained|s&  z:_BaseAutoBackboneClass._load_timm_backbone_from_pretrainedcsB|dd}|r|j|g|Ri|Stj|g|Ri|S)Nuse_timm_backboneF)rLrrr)rXrarr5rrrrrs z&_BaseAutoBackboneClass.from_pretrained)rrrrNrrr __classcell__rrrrrxs rhead_doccCs,t|dkr|dd|dS|ddS)Nrz(one of the model classes of the library z0one of the model classes of the library (with a z head) z-one of the base model classes of the library )lenreplace) docstringrrrrinsert_head_docs  rgoogle-bert/bert-base-casedcheckpoint_for_examplec Cs|j}|j}tt|d}|d||_ttj}tt |d}|d|}|d|}||_t |jdd|}t ||_| drCt }n | drKt}nt}ttj} t||d}|d|}|d|}|dd d d } |d | }|| _t |j| } t | |_|S) N)rBaseAutoModelClasscheckpoint_placeholderF)use_model_typesr"r#/-rshortcut_placeholder)rNrrCLASS_DOCSTRINGr__doc__r r/r_FROM_CONFIG_DOCSTRINGrr startswithFROM_PRETRAINED_TF_DOCSTRINGFROM_PRETRAINED_FLAX_DOCSTRINGFROM_PRETRAINED_TORCH_DOCSTRINGrrO) rXrrr*rlclass_docstringr_from_config_docstringfrom_pretrained_docstringrshortcutrrrauto_class_updates4              rcCs<g}|D]}t|ttfr|t|7}q||q|SrF)valuesr%r&r'append)r*resultrrrr get_valuess   rc s|durdSt|trtfdd|DSt|r t|Std}|krEzt||WStyDtd|dd|dwtd|d|d) Nc3s|]}t|VqdSrF)getattribute_from_module)ramodulerrrIsz+getattribute_from_module.. transformerszCould not find z neither in z nor in !z in )r%r'rMr( importlib import_modulerrV)rattrtransformers_modulerrrrs      rcCsdt|jvr |Sdt|jvr|St|dodtt|dv}t|do-dtt|dv}|s2|r@t|j|tfi|j}|S|S)a Adds `GenerationMixin` to the inheritance of `model_class`, if `model_class` is a PyTorch model. This function is used for backwards compatibility purposes: in v4.45, we've started a deprecation cycle to make `PreTrainedModel` stop inheriting from `GenerationMixin`. Without this function, older models dynamically loaded from the Hub may not have the `generate` method after we remove the inheritance. ztorch.nn.modules.module.Modulergenerateprepare_inputs_for_generation) r__mro__ __bases__rMr(r$rr__dict__)r]has_custom_generate_in_classhas_custom_prepare_inputs!model_class_with_generation_mixinrrrrTs  rTc@seZdZdZd!ddZdefddZdeede fd d Z d d Z de eefd dZ deededee effddZdefddZde e fddZde eeee ffddZdeeefddZdedefddZd"deede ddfdd ZdS)#_LazyAutoMappinga " A mapping config to object (model or tokenizer for instance) that will load keys and values when it is accessed. Args: - config_mapping: The map model type to config class - model_mapping: The map model type to model (or tokenizer) class r0NcCs8||_dd|D|_||_||j_i|_i|_dS)NcSsi|]\}}||qSrrrkvrrrr sz-_LazyAutoMapping.__init__..)_config_mappingitems_reverse_config_mappingrN_extra_content_modules)r3config_mappingr*rrrr6s  z_LazyAutoMapping.__init__cCs,t|j|j}t|t|jSrF)setrkeys intersectionrNrr)r3 common_keysrrr__len__sz_LazyAutoMapping.__len__keycs|jvr |jS|jj}||jvr |j|}|||Sfdd|jD}|D]}||jvrB|j|}|||Sq.t)Ncsg|] \}}|jkr|qSrrrrrr *sz0_LazyAutoMapping.__getitem__..)rrrrN_load_attr_from_modulerrKeyError)r3r model_type model_name model_typesmtyperrr __getitem__!s        z_LazyAutoMapping.__getitem__cCs:t|}||jvrtd|d|j|<t|j||S)NrKztransformers.models)rrrrr)r3rr module_namerrrr1s z'_LazyAutoMapping._load_attr_from_modulec*fddjD}|tjS)Nc&g|]\}}|jvr||qSr)rNrrrrlr3rrr8   z)_LazyAutoMapping.keys..)rrr&rr)r3 mapping_keysrrrr7 z_LazyAutoMapping.keysdefaultcCs$z||WSty|YSwrF)rr)r3rrrrrr}?s   z_LazyAutoMapping.getcC t|SrF)boolrrrrr__bool__E z_LazyAutoMapping.__bool__cr)Ncrr)rrrrrrrIrz+_LazyAutoMapping.values..)rNrr&rr)r3mapping_valuesrrrrHrz_LazyAutoMapping.valuescs&fddjD}|tjS)Ncs:g|]}|jvr|j||j|fqSr)rrrN)rrrrrrQs z*_LazyAutoMapping.items..)rNr&rr)r3 mapping_itemsrrrrPs z_LazyAutoMapping.itemscCrrF)iterrrrrr__iter__[rz_LazyAutoMapping.__iter__itemcCs>||jvrdSt|dr|j|jvrdS|j|j}||jvS)NTrF)rrMrrrN)r3rrrrr __contains__^s   z_LazyAutoMapping.__contains__FvaluecCsNt|dr |j|jvr |j|j}||jvr |s td|d||j|<dS)z7 Register a new model in this mapping. r'z*' is already used by a Transformers model.N)rMrrrNrVr)r3rr r=rrrrrRfs  z_LazyAutoMapping.registerrr)rrrrr6intrr$r_LazyAutoMappingValuerrr&rrrr}rrrr'rrrrrRrrrrr s "  r)r)rr):rrrrrr~ collectionsrcollections.abcrtypingrrrconfiguration_utilsrdynamic_module_utilsr r utilsr r r rrrrrrconfiguration_autorrr generationr get_loggerrloggerrr'r$r rrrrrr.r/rrrrrrrTr__all__rrrrsD   ,   $lcd\' #  f