U
9%e @ s d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z m Z e rXddl
mZ neZerlddl
mZ G dd d eZd
S ) zFContains a logger to push training logs to the Hub, using Tensorboard. )Path)
TYPE_CHECKINGListOptionalUnion)CommitScheduler ) experimentalis_tensorboard_available)
SummaryWriterc s e Zd ZdZed d fdd Zdddddddd ddd
eee ee e
f e ee ee e ee eee e ef eee e ef ee d fd d
Z
fddZ ZS )HFSummaryWriteraL
Wrapper around the tensorboard's `SummaryWriter` to push training logs to the Hub.
Data is logged locally and then pushed to the Hub asynchronously. Pushing data to the Hub is done in a separate
thread to avoid blocking the training script. In particular, if the upload fails for any reason (e.g. a connection
issue), the main script will not be interrupted. Data is automatically pushed to the Hub every `commit_every`
minutes (default to every 5 minutes).
`HFSummaryWriter` is experimental. Its API is subject to change in the future without prior notice.
Args:
repo_id (`str`):
The id of the repo to which the logs will be pushed.
logdir (`str`, *optional*):
The directory where the logs will be written. If not specified, a local directory will be created by the
underlying `SummaryWriter` object.
commit_every (`int` or `float`, *optional*):
The frequency (in minutes) at which the logs will be pushed to the Hub. Defaults to 5 minutes.
squash_history (`bool`, *optional*):
Whether to squash the history of the repo after each commit. Defaults to `False`. Squashing commits is
useful to avoid degraded performances on the repo when it grows too large.
repo_type (`str`, *optional*):
The type of the repo to which the logs will be pushed. Defaults to "model".
repo_revision (`str`, *optional*):
The revision of the repo to which the logs will be pushed. Defaults to "main".
repo_private (`bool`, *optional*):
Whether to create a private repo or not. Defaults to False. This argument is ignored if the repo already
exists.
path_in_repo (`str`, *optional*):
The path to the folder in the repo where the logs will be pushed. Defaults to "tensorboard/".
repo_allow_patterns (`List[str]` or `str`, *optional*):
A list of patterns to include in the upload. Defaults to `"*.tfevents.*"`. Check out the
[upload guide](https://huggingface.co/docs/huggingface_hub/guides/upload#upload-a-folder) for more details.
repo_ignore_patterns (`List[str]` or `str`, *optional*):
A list of patterns to exclude in the upload. Check out the
[upload guide](https://huggingface.co/docs/huggingface_hub/guides/upload#upload-a-folder) for more details.
token (`str`, *optional*):
Authentication token. Will default to the stored token. See https://huggingface.co/settings/token for more
details
kwargs:
Additional keyword arguments passed to `SummaryWriter`.
Examples:
```py
>>> from huggingface_hub import HFSummaryWriter
# Logs are automatically pushed every 15 minutes
>>> logger = HFSummaryWriter(repo_id="test_hf_logger", commit_every=15)
>>> logger.add_scalar("a", 1)
>>> logger.add_scalar("b", 2)
...
# You can also trigger a push manually
>>> logger.scheduler.trigger()
```
```py
>>> from huggingface_hub import HFSummaryWriter
# Logs are automatically pushed every 5 minutes (default) + when exiting the context manager
>>> with HFSummaryWriter(repo_id="test_hf_logger") as logger:
... logger.add_scalar("a", 1)
... logger.add_scalar("b", 2)
```
)returnc s t stdt | S )NzvYou must have `tensorboard` installed to use `HFSummaryWriter`. Please run `pip install --upgrade tensorboardX` first.)r
ImportErrorsuper__new__)clsargskwargs __class__ b/var/www/html/Darija-Ai-API/env/lib/python3.8/site-packages/huggingface_hub/_tensorboard_logger.pyr i s
zHFSummaryWriter.__new__N FZ tensorboardz *.tfevents.*)
logdir commit_everysquash_history repo_type
repo_revision repo_private path_in_reporepo_allow_patternsrepo_ignore_patternstoken) repo_idr r r r r r r r r! r" c
s t jf d|i| t| jts@td| j dt| j d|d ksP|dkr^t| jj}n| dd t| jj }t
| j|||||| | |
||d | _ | j j | _ | j j
| _
| j j| _d S )Nr z%`self.logdir` must be a string. Got 'z
' of type . /) Z folder_pathr r# r revisionprivater" Zallow_patternsignore_patternsZeveryr )r __init__
isinstancer str
ValueErrortyper namestripr schedulerr# r r' r )
selfr# r r r r r r r r r! r" r r r r r* r s,
zHFSummaryWriter.__init__c s& t ||| | j }| dS )zLPush to hub in a non-blocking way when exiting the logger's context manager.N)r __exit__r1 triggerresult)r2 exc_typeexc_valexc_tbfuturer r r r3 s
zHFSummaryWriter.__exit__)__name__
__module__ __qualname____doc__r r r, r r intfloatboolr r* r3
__classcell__r r r r r " s6 F
1r N)r= pathlibr typingr r r r Z!huggingface_hub._commit_schedulerr utilsr r
Z tensorboardXr objectr r r r r s