j dZddlmZddlmZddlmZddlmZddl m Z  ddl m Z d Zn1#e$r) ddlm Z d Zn#e$rGd d ZeZ d ZYnwxYwYnwxYwGd de ZdS)zFContains a logger to push training logs to the Hub, using Tensorboard.)Path)CommitScheduler)EntryNotFoundError) ModelCard) experimental) SummaryWriterTceZdZdS)_DummySummaryWriterN)__name__ __module__ __qualname__f/var/www/html/Carbon-Document/venv/lib/python3.11/site-packages/huggingface_hub/_tensorboard_logger.pyr r &s Drr FceZdZdZedfd Zddddddddddd d ed edzd eezd e dedzdedzde dzdedzde eezdzde eezdzdedzffdZ fdZ xZ S)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). > [!WARNING] > `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) ``` returncrtstdt|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 rrzHFSummaryWriter.__new__ts:* ( wws###rNF 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 ftjd d|i| t|jts-t d|jdt |jd||dkrt|jj}n2| ddzt|jjz}t|j|||||| | | || |_ |j j |_ |j j |_ |j j|_ t!j|j |j } n#t$$rt!d} YnwxYw| jd g}d |vrB|d || jd <| |j |j dSdS) 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)r__init__ isinstancer str ValueErrortypernamestripr schedulerr*r#r0r$rloadrdatagetappend push_to_hub)selfr*r r!r"r#r$r%r&r'r(r)rcardr6rs rr7zHFSummaryWriter.__init__}s" 111&111$+s++ rpT[pp\`aeal\m\mpppqq q  <2#5#5 ,,1LL'--c22S84 ;L;L;QQL) %" .0)    ~- 1!^4 !>$,$.YYYDD! ! ! !R==DDD !y}}VR(( d * * KK+ , , , $DIf    T\T^  L L L L L + *s D11E  E ct||||j}|dS)zLPush to hub in a non-blocking way when exiting the logger's context manager.N)r__exit__r>triggerresult)rDexc_typeexc_valexc_tbfuturers rrGzHFSummaryWriter.__exit__sC 7F333'')) r)rr)r r r__doc__rrr9intfloatboollistr7rG __classcell__)rs@rrr-smDDL$$$$$\$"$%$ $$($(#06D7; :M:M:M:Md :M Ek :M  :M::MTz:MTk:MDj:M"#Y_t3:M#3i#o4:MTz:M:M:M:M:M:MxrrN)rNpathlibr_commit_schedulerrerrorsrrepocardrutilsr tensorboardXr _RuntimeSummaryWriterrrtorch.utils.tensorboardr rrrrr\s[ML......&&&&&& ,CCCCCC"& , , , ,RRRRRR&*## ,,,        !4&+### , ,PPPPP+PPPPPs/+A:AAAAAA