g d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z ddl m
Z
ddlmZ dd lmZ d
Zerdd lmZ G d d
e Zy# e$ r dd lmZ d Zn# e$ r eZd ZY nw xY wY 4w xY w)zFContains a logger to push training logs to the Hub, using Tensorboard. )Path)
TYPE_CHECKINGListOptionalUnion )CommitScheduler)EntryNotFoundError) ModelCard) experimental)
SummaryWriterTFc e Zd ZdZed fd Zddddddddddd
d ed
ee d ee e
f d e d
ee dee dee dee deee e ef deee e ef dee f fdZ
fdZ xZS )HFSummaryWritera
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 make the repo private. If `None` (default), the repo will be public unless the organization's default is private. This value 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:
```diff
# Taken from https://pytorch.org/docs/stable/tensorboard.html
- from torch.utils.tensorboard import SummaryWriter
+ from huggingface_hub import HFSummaryWriter
import numpy as np
- writer = SummaryWriter()
+ writer = HFSummaryWriter(repo_id="username/my-trained-model")
for n_iter in range(100):
writer.add_scalar('Loss/train', np.random.random(), n_iter)
writer.add_scalar('Loss/test', np.random.random(), n_iter)
writer.add_scalar('Accuracy/train', np.random.random(), n_iter)
writer.add_scalar('Accuracy/test', np.random.random(), n_iter)
```
```py
>>> from huggingface_hub import HFSummaryWriter
# Logs are automatically pushed every 15 minutes (5 by default) + when exiting the context manager
>>> with HFSummaryWriter(repo_id="test_hf_logger", commit_every=15) as logger:
... logger.add_scalar("a", 1)
... logger.add_scalar("b", 2)
```
c D t s t d t |
| S )NzvYou must have `tensorboard` installed to use `HFSummaryWriter`. Please run `pip install --upgrade tensorboardX` first.)is_summary_writer_available ImportErrorsuper__new__)clsargskwargs __class__s X/var/www/openai/venv/lib/python3.12/site-packages/huggingface_hub/_tensorboard_logger.pyr zHFSummaryWriter.__new__y s) * (
ws## N F tensorboardz *.tfevents.*)
logdir commit_everysquash_history repo_type
repo_revision repo_private path_in_reporepo_allow_patternsrepo_ignore_patternstokenrepo_idr r r r r! r" r# r$ r% r& c
t | d d|i| t | j t s/t d| j dt
| j d ||dk( r t | j j }n4|j d dz t | j j z }t | j |||||| | |
|| | _ | j j | _ | j j | _
| j j | _ t! j" | j | j }
|
j& j) d g }d
|vrH|j+ d
||
j& d < |
j- | j | j y y # t$ $ r t! d }
Y w xY w)
Nr z%`self.logdir` must be a string. Got 'z
' of type . /) folder_pathr# r' r revisionprivater& allow_patternsignore_patternseveryr )repo_id_or_pathr tagszhf-summary-writer)r' r )r __init__
isinstancer str
ValueErrortyper namestripr schedulerr' r r- r! r loadr
datagetappend push_to_hub)selfr' r r r r r! r" r# r$ r% r& r cardr3 r s r r5 zHFSummaryWriter.__init__ s " 11&1 $++s+ DT[[MQ[\`aealal\m[nno pq q <2#5 ,11L'--c2S84 ;L;Q;QQL ) % " . 0 )
~~-- 11 !^^ 4 4 ! >>$,,$..YD yy}}VR( d * KK+ , $DIIf T\\T^^ L + " ! R=D !s .+G GGc | t | ||| | j j }|j y)zLPush to hub in a non-blocking way when exiting the logger's context manager.N)r __exit__r< triggerresult)rB exc_typeexc_valexc_tbfuturer s r rE zHFSummaryWriter.__exit__ s/
7F3 '')
r )returnr )__name__
__module__ __qualname____doc__r r r7 r r intfloatboolr r5 rE
__classcell__)r s @r r r / s GR $ $ !%*+ $#''+'+&3?M@D #:M:M
:M
CJ' :M
:M C=:M }:M tn:M sm:M &eDIsN&; <:M 'uT#Y^'< =:M }:Mx r r N)rP pathlibr typingr r r r _commit_schedulerr errorsr
repocardr utilsr tensorboardXr
r r torch.utils.tensorboardobjectr r4 r r r^ s} M 7 7 . &
,*"& *Sm S ,,9&+# ,
&+#, ,s5 A
A+AA+ A%"A+$A%%A+*A+