l$e?ddlZddlZddlmZddlmZmZmZmZm Z m Z ddl Z ddl m Z mZddlmZmZddlmZddlmZmZmZerddlZejeZe d d ZGd d ZGd deZdS)N)Path)DictListOptionalTypeTypeVarUnion) CONFIG_NAMEPYTORCH_WEIGHTS_NAME)hf_hub_downloadis_torch_available)HfApi)SoftTemporaryDirectoryloggingvalidate_hf_hub_argsT ModelHubMixin)boundceZdZdZdddddeeefdeedeede d eef d Z ded dfd Z e e dddddddd d eedeeefde de deedeeee fdeeeefde deed efdZe d eededeedeeeefde deede de deeee fd efdZe ddddddddddd dedeedede deedeedeedee d eeeeefd!eeeeefd"eeeeefd efd#ZdS)$ra A generic mixin to integrate ANY machine learning framework with the Hub. To integrate your framework, your model class must inherit from this class. Custom logic for saving/loading models have to be overwritten in [`_from_pretrained`] and [`_save_pretrained`]. [`PyTorchModelHubMixin`] is a good example of mixin integration with the Hub. Check out our [integration guide](../guides/integrations) for more instructions. NF)configrepo_id push_to_hubsave_directoryrrrreturnc nt|}|dd||t|tr/|t z tj||r3| }|||d<||j }|j dd|i|SdS)a Save weights in local directory. Args: save_directory (`str` or `Path`): Path to directory in which the model weights and configuration will be saved. config (`dict`, *optional*): Model configuration specified as a key/value dictionary. push_to_hub (`bool`, *optional*, defaults to `False`): Whether or not to push your model to the Huggingface Hub after saving it. repo_id (`str`, *optional*): ID of your repository on the Hub. Used only if `push_to_hub=True`. Will default to the folder name if not provided. kwargs: Additional key word arguments passed along to the [`~ModelHubMixin._from_pretrained`] method. T)parentsexist_okNrr) rmkdir_save_pretrained isinstancedictr write_textjsondumpscopynamer)selfrrrrkwargss 9lib/python3.11/site-packages/huggingface_hub/hub_mixin.pysave_pretrainedzModelHubMixin.save_pretrained s2n--TD999 n--- fd # # J k ) 5 5dj6H6H I I I  ?[[]]F!#)x (-#4#>>G>v>> >tct)aD Overwrite this method in subclass to define how to save your model. Check out our [integration guide](../guides/integrations) for instructions. Args: save_directory (`str` or `Path`): Path to directory in which the model weights and configuration will be saved. NotImplementedError)r)rs r+r!zModelHubMixin._save_pretrainedLs "!r-)force_downloadresume_downloadproxiestoken cache_dirlocal_files_onlyrevisionclspretrained_model_name_or_pathr1r2r3r4r5r6r7c @|} d} tj| rttj| vr&tj| t} nt tdt|  n}t| trh tt| t||||||| } n<#tjj$r%t tdYnwxYw| Ut!| dd5} t#j| } dddn #1swxYwY| d| i|jd t| |||||||d | S) a Download a model from the Huggingface Hub and instantiate it. Args: pretrained_model_name_or_path (`str`, `Path`): - Either the `model_id` (string) of a model hosted on the Hub, e.g. `bigscience/bloom`. - Or a path to a `directory` containing model weights saved using [`~transformers.PreTrainedModel.save_pretrained`], e.g., `../path/to/my_model_directory/`. revision (`str`, *optional*): Revision of the model on the Hub. Can be a branch name, a git tag or any commit id. Defaults to the latest commit on `main` branch. force_download (`bool`, *optional*, defaults to `False`): Whether to force (re-)downloading the model weights and configuration files from the Hub, overriding the existing cache. resume_download (`bool`, *optional*, defaults to `False`): Whether to delete incompletely received files. Will attempt to resume the download if such a file exists. 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 every request. token (`str` or `bool`, *optional*): The token to use as HTTP bearer authorization for remote files. By default, it will use the token cached when running `huggingface-cli login`. cache_dir (`str`, `Path`, *optional*): Path to the folder where cached files are stored. local_files_only (`bool`, *optional*, defaults to `False`): If `True`, avoid downloading the file and return the path to the local cached file if it exists. model_kwargs (`Dict`, *optional*): Additional kwargs to pass to the model during initialization. Nz not found in rfilenamer7r5r1r3r2r4r6z not found in HuggingFace Hub.rzutf-8)encodingr)model_idr7r5r1r3r2r6r4r)ospathisdirr listdirjoinloggerwarningrresolver"strr requests exceptionsRequestExceptionopenr%loadupdate_from_pretrained)r8r9r1r2r3r4r5r6r7 model_kwargsr? config_filefrs r+from_pretrainedzModelHubMixin.from_pretrainedWsX1%) 7== " " Obj2222 gll8[AA +WWT(^^=S=S=U=UWWXXXX # & & O O-MM(%'#1#$3%5    &7 O O O+MMMNNNNN O  "k3999 &Q1 & & & & & & & & & & & & & & &   6 2 3 3 3#s#  ]])+-      s$?*C**6D#"D#:EE"Er?c t)aOverwrite this method in subclass to define how to load your model from pretrained. Use [`hf_hub_download`] or [`snapshot_download`] to download files from the Hub before loading them. Most args taken as input can be directly passed to those 2 methods. If needed, you can add more arguments to this method using "model_kwargs". For example [`PyTorchModelHubMixin._from_pretrained`] takes as input a `map_location` parameter to set on which device the model should be loaded. Check out our [integration guide](../guides/integrations) for more instructions. Args: model_id (`str`): ID of the model to load from the Huggingface Hub (e.g. `bigscience/bloom`). revision (`str`, *optional*): Revision of the model on the Hub. Can be a branch name, a git tag or any commit id. Defaults to the latest commit on `main` branch. force_download (`bool`, *optional*, defaults to `False`): Whether to force (re-)downloading the model weights and configuration files from the Hub, overriding the existing cache. resume_download (`bool`, *optional*, defaults to `False`): Whether to delete incompletely received files. Will attempt to resume the download if such a file exists. 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'}`). token (`str` or `bool`, *optional*): The token to use as HTTP bearer authorization for remote files. By default, it will use the token cached when running `huggingface-cli login`. cache_dir (`str`, `Path`, *optional*): Path to the folder where cached files are stored. local_files_only (`bool`, *optional*, defaults to `False`): If `True`, avoid downloading the file and return the path to the local cached file if it exists. model_kwargs: Additional keyword arguments passed along to the [`~ModelHubMixin._from_pretrained`] method. r/) r8r?r7r5r1r3r2r6r4rPs r+rOzModelHubMixin._from_pretraineds ^"!r-z!Push model using huggingface_hub.) rcommit_messageprivate api_endpointr4branch create_prallow_patternsignore_patternsdelete_patternsrUrVrWrXrYrZr[r\c <t||} | ||dj}t5} t | |z }|||| |d||||| | |  cdddS#1swxYwYdS)a Upload model checkpoint to the Hub. Use `allow_patterns` and `ignore_patterns` to precisely filter which files should be pushed to the hub. Use `delete_patterns` to delete existing remote files in the same commit. See [`upload_folder`] reference for more details. Args: repo_id (`str`): ID of the repository to push to (example: `"username/my-model"`). config (`dict`, *optional*): Configuration object to be saved alongside the model weights. commit_message (`str`, *optional*): Message to commit while pushing. private (`bool`, *optional*, defaults to `False`): Whether the repository created should be private. api_endpoint (`str`, *optional*): The API endpoint to use when pushing the model to the hub. token (`str`, *optional*): The token to use as HTTP bearer authorization for remote files. By default, it will use the token cached when running `huggingface-cli login`. branch (`str`, *optional*): The git branch on which to push the model. This defaults to `"main"`. create_pr (`boolean`, *optional*): Whether or not to create a Pull Request from `branch` with that commit. Defaults to `False`. allow_patterns (`List[str]` or `str`, *optional*): If provided, only files matching at least one pattern are pushed. ignore_patterns (`List[str]` or `str`, *optional*): If provided, files matching any of the patterns are not pushed. delete_patterns (`List[str]` or `str`, *optional*): If provided, remote files matching any of the patterns will be deleted from the repo. Returns: The url of the commit of your model in the given repository. )endpointr4T)rrVr)rmodel) r repo_type folder_pathrUr7rYrZr[r\N)r create_reporrrr, upload_folder)r)rrrUrVrWr4rXrYrZr[r\apitmp saved_paths r+rzModelHubMixin.push_to_hubsh\777//'7T/RRZ$ % % cW,J  F ; ; ;$$!&-#- / /%                    sABBB)__name__ __module__ __qualname____doc__r rHrrr#boolr,r! classmethodrrrrrSrOrrrr-r+rrsg"&!%! ***c4i(* * # *  * #****X "t " " " " " % %"&,004!&"&P P P !WP ',S$Y'7P  P  P $ P c4i()P E#t),-P P 3-P  P P P [P d." !W."."3- ." E#t),- ."  ."$."."."c4i()." ."."."[."` "&A&*# $$(:>;?;?DDDD D  D  DsmD}D DD>D!tCy#~!67D"%S 3"78D"%S 3"78D DDDDDDr-ceZdZdZdeddfdZedddd ed eed ee eefd e d ee de de de ee dfdede fdZ dS)PyTorchModelHubMixinaL Implementation of [`ModelHubMixin`] to provide model Hub upload/download capabilities to PyTorch models. The model is set in evaluation mode by default using `model.eval()` (dropout modules are deactivated). To train the model, you should first set it back in training mode with `model.train()`. Example: ```python >>> import torch >>> import torch.nn as nn >>> from huggingface_hub import PyTorchModelHubMixin >>> class MyModel(nn.Module, PyTorchModelHubMixin): ... def __init__(self): ... super().__init__() ... self.param = nn.Parameter(torch.rand(3, 4)) ... self.linear = nn.Linear(4, 5) ... def forward(self, x): ... return self.linear(x + self.param) >>> model = MyModel() # Save model weights to local directory >>> model.save_pretrained("my-awesome-model") # Push model weights to the Hub >>> model.push_to_hub("my-awesome-model") # Download and initialize weights from the Hub >>> model = MyModel.from_pretrained("username/my-awesome-model") ``` rrNct|dr|jn|}tj||t z dS)z7Save weights from a Pytorch model to a local directory.moduleN)hasattrrptorchsave state_dictr )r)r model_to_saves r+r!z%PyTorchModelHubMixin._save_pretrainedGsF'.tX'>'>H D  =++--~@T/TUUUUUr-cpuF) map_locationstrictr?r7r5r1r3r2r6r4rwrxc tj|r5tdtj|t } nt |t ||||||| } |di| } tj| tj | }| || | | S)zrsu ================88888888>>>>>>>>HHHHHHHHHHLLL  H % % GC'''JJJJJJJJZNNNNN=NNNNNr-