Files
nerfstudio/mattport/utils/writer.py
T
evonneng bf3b77f952 Eng/distributed training (#27)
* added checkpointing logic

* small nits
2022-04-20 12:06:29 -07:00

105 lines
3.0 KiB
Python

"""
Generic Writer class
"""
from abc import abstractmethod
import torch
from torch.utils.tensorboard import SummaryWriter
from torchtyping import TensorType
from mattport.utils.decorators import check_main_thread
class Writer:
"""Writer class"""
def __init__(self, local_rank: int, world_size: int, save_dir: str):
self.save_dir = save_dir
self.writer = None
self.is_main_thread = local_rank % world_size == 0
@abstractmethod
def write_image(self, name: str, x: TensorType["H", "W", 3]) -> None:
"""_summary_
Args:
name (str): data identifier
x (TensorType["H", "W", 3]): rendered image to write
"""
raise NotImplementedError
@abstractmethod
def write_text(self, name: str, x: str) -> None:
"""Required method to write a string to summary
Args:
name (str): data identifier
x (str): string to write
"""
raise NotImplementedError
@abstractmethod
def write_scalar(self, name: str, x: float, y: float) -> None:
"""Required method to write a single scalar value to the logger
Args:
name (str): data identifier
x (float): x value to write
y (float): y value to write
"""
raise NotImplementedError
def write_scalar_dict(self, scalar_dict: dict) -> None:
"""Function that writes out all scalars from a given dictionary to the logger
Args:
scalar_dict (dict): dictionary containing all scalar values
"""
if self.is_main_thread:
for name, (x, y) in scalar_dict.items():
self.writer.write_scalar(name, x, y)
class TensorboardWriter(Writer):
"""Tensorboard Writer Class"""
def __init__(self, local_rank: int, world_size: int, save_dir: str):
super().__init__(local_rank, world_size, save_dir)
if self.is_main_thread:
self.writer = SummaryWriter(log_dir=self.save_dir)
@check_main_thread
def write_image(self, name: str, x: TensorType["H", "W", 3]) -> None:
"""_summary_
Args:
name (str): data identifier
x (TensorType["H", "W", 3]): rendered image to write
"""
to8b = lambda x: (255 * torch.clip(x, 0, 1)).to(torch.uint8)
x = to8b(x)
self.writer.add_images(name, x)
@check_main_thread
def write_text(self, name: str, x: str) -> None:
"""Tensorboard method to write a string to summary
Args:
name (str): data identifier
x (str): string to write
"""
self.writer.add_text(name, x)
@check_main_thread
def write_scalar(self, name: str, x: float, y: float) -> None:
"""Tensorboard method to write a single scalar value to the logger
Args:
name (str): data identifier
x (float): x value to write
y (float): y value to write
"""
self.writer.add_scalar(name, x, y)