o
vZh @ s d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z ddl m
Z
ddlmZ z
dd lmZ d
ZW n! eyW z
dd lmZ d ZW n
eyT eZd ZY nw Y nw er`dd lmZ G d d
d
eZdS )zFContains a logger to push training logs to the Hub, using Tensorboard. )Path)
TYPE_CHECKINGListOptionalUnion )CommitScheduler)EntryNotFoundError) ModelCard) experimental)
SummaryWriterTFc s e Zd ZdZed fdd Zdddddddd ddd
d ed ee d
ee e
f de dee dee dee dee deee e ef deee e ef dee f fddZ
fddZ ZS )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)
```
returnc s t stdt | S )NzvYou must have `tensorboard` installed to use `HFSummaryWriter`. Please run `pip install --upgrade tensorboardX` first.)is_summary_writer_available ImportErrorsuper__new__)clsargskwargs __class__ R/var/www/auris/lib/python3.10/site-packages/huggingface_hub/_tensorboard_logger.pyr y s
zHFSummaryWriter.__new__N FZ 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
s. t jd d|i| t| jts td| j dt| j d|d u s(|dkr/t| jj}n
| dd t| jj }t
| j|||||| | |
||d | _ | j j | _ | j j
| _
| j j| _z tj| j | j
d}
W n
tyt td}
Y nw |
jd g }d
|vr|d
||
jd < |
j| j | j
d d S d S )
Nr z%`self.logdir` must be a string. Got 'z
' of type . /) Z folder_pathr! r% r revisionprivater$ Zallow_patternsignore_patternsZeveryr )Zrepo_id_or_pathr tagszhf-summary-writer)r% r r )r __init__
isinstancer str
ValueErrortyper namestripr schedulerr% r r) r r
loadr datagetappendZ push_to_hub)selfr% r r r r r r r! r" r# r$ r Zcardr, r r r r- sB
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__r4 triggerresult)r9 exc_typeexc_valexc_tbfuturer r r r: s
zHFSummaryWriter.__exit__)r r
)__name__
__module__ __qualname____doc__r r r/ r r intfloatboolr r- r:
__classcell__r r r r r
/ sL I
s.