mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 12:21:27 +01:00
b136f3f310
Follow up to #82797 Now that the doctests themselves are in a better state, we should be able to enable xdoctest on the CI so they stay that way. @ezyang @vadimkantorov Pull Request resolved: https://github.com/pytorch/pytorch/pull/83317 Approved by: https://github.com/ezyang
35 lines
1.1 KiB
Python
35 lines
1.1 KiB
Python
from torch._C._monitor import * # noqa: F403
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
if TYPE_CHECKING:
|
|
from torch.utils.tensorboard import SummaryWriter
|
|
|
|
|
|
STAT_EVENT = "torch.monitor.Stat"
|
|
|
|
class TensorboardEventHandler:
|
|
"""
|
|
TensorboardEventHandler is an event handler that will write known events to
|
|
the provided SummaryWriter.
|
|
|
|
This currently only supports ``torch.monitor.Stat`` events which are logged
|
|
as scalars.
|
|
|
|
>>> # xdoctest: +REQUIRES(module:tensorboard)
|
|
>>> from torch.utils.tensorboard import SummaryWriter
|
|
>>> from torch.monitor import TensorboardEventHandler, register_event_handler
|
|
>>> writer = SummaryWriter("log_dir")
|
|
>>> register_event_handler(TensorboardEventHandler(writer))
|
|
"""
|
|
def __init__(self, writer: "SummaryWriter") -> None:
|
|
"""
|
|
Constructs the ``TensorboardEventHandler``.
|
|
"""
|
|
self._writer = writer
|
|
|
|
def __call__(self, event: Event) -> None:
|
|
if event.name == STAT_EVENT:
|
|
for k, v in event.data.items():
|
|
self._writer.add_scalar(k, v, walltime=event.timestamp.timestamp())
|