o
eI ! @ s& d dl mZ d dlZd dlZd dlZd dlmZ d dlm Z d dl
m Z m Z m
Z
mZmZ d dlmZmZ d dlmZmZmZmZmZ ddlmZ dd lm Z dd
l m Z m Z m Z e !e"Z#e rdd dl$Z%d3d d
Z&dd Z'dd Z( d4dede)dee* fddZ+ d5dee,ef dee e,e f de)de)d eee-e,f f
d d Z.d6d!d"Z/e dd#ddddddddddddd$d%e,dee* d&e,d'e)d(ee, d)ee, d*ee, d+ee) d,eee
e, e,f d-eee
e, e,f d.eee
e, e,f d/ee, de)d eee-e,f de)f d0d1Z0G d2d d eZ1dS )7 N)Path)copytree)AnyDictListOptionalUnion)
ModelHubMixinsnapshot_download)get_tf_versionis_graphviz_availableis_pydot_availableis_tf_available yaml_dump ) CONFIG_NAME)HfApi)SoftTemporaryDirectoryloggingvalidate_hf_hub_args c C sd g }| D ]'\}}|r| d| n|}t|tjr&|t|| q|||f qt|S )a Flatten a nested dictionary.
Reference: https://stackoverflow.com/a/6027615/10319735
Args:
dictionary (`dict`):
The nested dictionary to be flattened.
parent_key (`str`):
The parent key to be prefixed to the children keys.
Necessary for recursing over the nested dictionary.
Returns:
The flattened dictionary.
.)items
isinstance collectionsMutableMappingextend
_flatten_dictappenddict)
dictionaryZ
parent_keyr keyvalueZnew_key r# KD:\Projects\ConvertPro\env\Lib\site-packages\huggingface_hub/keras_mixin.pyr s r c C sf | j dur/| j }t|}tjj j|d< d}| D ]\}}|d| d| d7 }q |S d}|S )z6Parse hyperparameter dictionary into a markdown table.NZtraining_precisionz*| Hyperparameters | Value |
| :-- | :-- |
z| z | z |
) Z optimizerZ
get_configr tfkerasZmixed_precisionZ
global_policynamer )modelZoptimizer_paramstabler! r" r# r# r$ _create_hyperparameter_table: s
r* c C s* t jjj| | dddddddd d d S )N
/model.pngFTTB` )Zto_fileZ show_shapesZ
show_dtypeZshow_layer_namesZrankdirZ
expand_nestedZdpiZ layer_range)r% r& utils
plot_model)r( save_directoryr# r# r$
_plot_networkI s
r1 Trepo_dirr/ metadatac
C st t | }|rt rt rt| | |du ri }| d}d|d< d}|t|dd7 }|d7 }|d7 }|d 7 }|d
7 }|durR|d 7 }|d 7 }|d
7 }||7 }|d7 }|rwtj| drw|d7 }|d7 }|d7 }d}|d| d7 }|d7 }tj|rt|ddd }| } W d n1 sw Y n|} t|ddd}|
| W d dS 1 sw Y dS ) z2
Creates a model card for the repository.
Nz
/README.mdr& library_namez---
F)Zdefault_flow_stylez/
## Model description
More information needed
z9
## Intended uses & limitations
More information needed
z:
## Training and evaluation data
More information needed
z
## Training procedure
z
### Training hyperparameters
z;
The following hyperparameters were used during training:
r+ z
## Model Plot
z
z$
View Model Plot
z ./model.pngz
z
rutf8encodingwutf-8) r* r r
r1 r ospathexistsopenreadwrite)
r( r2 r/ r3 ZhyperparametersZ readme_pathZ
model_cardZ path_to_plotfZreadmer# r# r$ _create_model_cardW sF
"rC Fr0 configinclude_optimizertagsc K s t rddl}ntd| jstdt|}|jddd |rLt|ts/t dt
| d|t d }t
|| W d n1 sGw Y i } t|trX|| d
< n
t|trb|g| d
< |d d}
|
durtd t d
| v r~| d
|
n|
g| d
< | jdur| jji kr|d
} | rtdt | j d dd}t
j| jj|ddd W d n1 sw Y t| ||| |jjj | |fd|i| dS )aE
Saves a Keras model to save_directory in SavedModel format. Use this if
you're using the Functional or Sequential APIs.
Args:
model (`Keras.Model`):
The [Keras
model](https://www.tensorflow.org/api_docs/python/tf/keras/Model)
you'd like to save. The model must be compiled and built.
save_directory (`str` or `Path`):
Specify directory in which you want to save the Keras model.
config (`dict`, *optional*):
Configuration object to be saved alongside the model weights.
include_optimizer(`bool`, *optional*, defaults to `False`):
Whether or not to include optimizer in serialization.
plot_model (`bool`, *optional*, defaults to `True`):
Setting this to `True` will plot the model and put it in the model
card. Requires graphviz and pydot to be installed.
tags (Union[`str`,`list`], *optional*):
List of tags that are related to model or string of a single tag. See example tags
[here](https://github.com/huggingface/hub-docs/blame/main/modelcard.md).
model_save_kwargs(`dict`, *optional*):
model_save_kwargs will be passed to
[`tf.keras.models.save_model()`](https://www.tensorflow.org/api_docs/python/tf/keras/models/save_model).
r Nz>Called a Tensorflow-specific function but could not import it.z+Model should be built before trying to saveT)parentsexist_okzAProvided config to save_pretrained_keras should be a dict. Got: ''r: rF task_namez>`task_name` input argument is deprecated. Pass `tags` instead.z history.jsonzZ`history.json` file already exists, it will be overwritten by the history of this version.r; r8 )indent sort_keysrE ) r
tensorflow ImportErrorZbuilt
ValueErrorr mkdirr r RuntimeErrortyper r? jsondumpliststrpopwarningswarn
FutureWarningr historyr> UserWarningrC r& modelsZ
save_model) r( r0 rD rE r/ rF model_save_kwargsr% rB r3 rJ r= r# r# r$ save_pretrained_keras sP "
r` returnKerasModelHubMixinc O s t j| i |S )a
Instantiate a pretrained Keras model from a pre-trained model from the Hub.
The model is expected to be in `SavedModel` format.
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. Valid model ids can be located
at the root-level, like `bert-base-uncased`, or namespaced
under a user or organization name, like
`dbmdz/bert-base-german-cased`.
- You can add `revision` by appending `@` at the end of model_id
simply like this: `dbmdz/bert-base-german-cased@main` Revision
is 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.
- A path to a `directory` containing model weights saved using
[`~transformers.PreTrainedModel.save_pretrained`], e.g.,
`./my_model_directory/`.
- `None` if you are both providing the configuration and state
dictionary (resp. with keyword arguments `config` and
`state_dict`).
force_download (`bool`, *optional*, defaults to `False`):
Whether to force the (re-)download of the model weights and
configuration files, overriding the cached versions if they exist.
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 each request.
token (`str` or `bool`, *optional*):
The token to use as HTTP bearer authorization for remote files. If
`True`, will use the token generated when running `transformers-cli
login` (stored in `~/.huggingface`).
cache_dir (`Union[str, 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.
local_files_only(`bool`, *optional*, defaults to `False`):
Whether to only look at local files (i.e., do not try to download
the model).
model_kwargs (`Dict`, *optional*):
model_kwargs will be passed to the model during initialization
Passing `token=True` is required when you want to use a private
model.
)rb Zfrom_pretrained)argskwargsr# r# r$ from_pretrained_keras s 8re z'Push Keras model using huggingface_hub.)rD commit_messageprivate api_endpointtokenbranch create_prallow_patternsignore_patternsdelete_patternslog_dirrE rF r/ repo_idrf rg rh ri rj rk rl rm rn ro c
K s t |d}|j|||ddj}t K}t|| }t| |f||
||d| | durG| du r1g n t| tr9| gn| } | d t | |d |j
d||||||| |
| d
W d S 1 s`w Y dS )
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:
model (`Keras.Model`):
The [Keras model](`https://www.tensorflow.org/api_docs/python/tf/keras/Model`) you'd like to push to the
Hub. The model must be compiled and built.
repo_id (`str`):
ID of the repository to push to (example: `"username/my-model"`).
commit_message (`str`, *optional*, defaults to "Add Keras model"):
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. If
not set, will use the token set when logging in with
`huggingface-cli login` (stored in `~/.huggingface`).
branch (`str`, *optional*):
The git branch on which to push the model. This defaults to
the default branch as specified in your repository, which
defaults to `"main"`.
create_pr (`boolean`, *optional*):
Whether or not to create a Pull Request from `branch` with that commit.
Defaults to `False`.
config (`dict`, *optional*):
Configuration object to be saved alongside the model weights.
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.
log_dir (`str`, *optional*):
TensorBoard logging directory to be pushed. The Hub automatically
hosts and displays a TensorBoard instance if log files are included
in the repository.
include_optimizer (`bool`, *optional*, defaults to `False`):
Whether or not to include optimizer during serialization.
tags (Union[`list`, `str`], *optional*):
List of tags that are related to model or string of a single tag. See example tags
[here](https://github.com/huggingface/hub-docs/blame/main/modelcard.md).
plot_model (`bool`, *optional*, defaults to `True`):
Setting this to `True` will plot the model and put it in the model
card. Requires graphviz and pydot to be installed.
model_save_kwargs(`dict`, *optional*):
model_save_kwargs will be passed to
[`tf.keras.models.save_model()`](https://www.tensorflow.org/api_docs/python/tf/keras/models/save_model).
Returns:
The url of the commit of your model in the given repository.
)ZendpointT)rp ri rg rH )rD rE rF r/ Nzlogs/*Zlogsr( )
Z repo_typerp Z folder_pathrf ri revisionrk rl rm rn ) r Z create_reporp r r r` r rW r r Z
upload_folder)r( rp rD rf rg rh ri rj rk rl rm rn ro rE rF r/ r_ apitmpZ
saved_pathr# r# r$ push_to_hub_keras sJ
N
$rt c @ s$ e Zd ZdZdd Zedd ZdS )rb aA
Implementation of [`ModelHubMixin`] to provide model Hub upload/download
capabilities to Keras models.
```python
>>> import tensorflow as tf
>>> from huggingface_hub import KerasModelHubMixin
>>> class MyModel(tf.keras.Model, KerasModelHubMixin):
... def __init__(self, **kwargs):
... super().__init__()
... self.config = kwargs.pop("config", None)
... self.dummy_inputs = ...
... self.layer = ...
... def call(self, *args):
... return ...
>>> # Initialize and compile the model as you normally would
>>> model = MyModel()
>>> model.compile(...)
>>> # Build the graph by training it or passing dummy inputs
>>> _ = model(model.dummy_inputs)
>>> # 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/super-cool-model")
```
c C s t | | d S )N)r` )selfr0 r# r# r$ _save_pretrained s z#KerasModelHubMixin._save_pretrainedc K sj t rddl}
ntd| dd} tj|s#t|||dt d} n|} |
j j
j | fi | }
| |
_ |
S )a Here we just call [`from_pretrained_keras`] function so both the mixin and
functional APIs stay in sync.
TODO - Some args above aren't used since we are calling
snapshot_download instead of hf_hub_download.
r Nz>Called a TensorFlow-specific function but could not import it.rD r& )rp rq cache_dirr4 Zlibrary_version)
r rN rO rX r< r= isdirr
r r& r^ Z
load_modelrD )clsZmodel_idrq rw Zforce_downloadproxiesZresume_downloadZlocal_files_onlyri Z model_kwargsr% cfgZstorage_folderr( r# r# r$ _from_pretrained s
z#KerasModelHubMixin._from_pretrainedN)__name__
__module__ __qualname____doc__rv classmethodr| r# r# r# r$ rb s
#)r )TN)NFTN)ra rb )2collections.abcabcr rT r< rY pathlibr shutilr typingr r r r r Zhuggingface_hubr r
Zhuggingface_hub.utilsr r r
r r constantsr Zhf_apir r. r r r Z
get_loggerr} loggerrN r% r r* r1 boolr rC rW rV r` re rt rb r# r# r# r$ s
0
U;
y