Skip to content

ocl.visualization_types

Classes for handling different types of visualizations.

SummaryWriter

Placeholder class for SummaryWriter.

Emulates interface of torch.utils.tensorboard.SummaryWriter.

Source code in ocl/visualization_types.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class SummaryWriter:
    """Placeholder class for SummaryWriter.

    Emulates interface of `torch.utils.tensorboard.SummaryWriter`.
    """

    def add_figure(self, *args, **kwargs):
        pass

    def add_image(self, *args, **kwargs):
        pass

    def add_images(self, *args, **kwargs):
        pass

    def add_video(self, *args, **kwargs):
        pass

    def add_embedding(self, *args, **kwargs):
        pass

Figure dataclass

Bases: Visualization

Matplotlib figure.

Source code in ocl/visualization_types.py 
42
43
44
45
46
47
48
49
50
@dataclasses.dataclass
class Figure(Visualization):
    """Matplotlib figure."""

    figure: matplotlib.pyplot.figure
    close: bool = True

    def add_to_experiment(self, experiment: SummaryWriter, tag: str, global_step: int):
        experiment.add_figure(**dataclass_to_dict(self), tag=tag, global_step=global_step)

Image dataclass

Bases: Visualization

Single image.

Source code in ocl/visualization_types.py 
53
54
55
56
57
58
59
60
61
@dataclasses.dataclass
class Image(Visualization):
    """Single image."""

    img_tensor: torch.Tensor
    dataformats: str = "CHW"

    def add_to_experiment(self, experiment: SummaryWriter, tag: str, global_step: int):
        experiment.add_image(**dataclass_to_dict(self), tag=tag, global_step=global_step)

Images dataclass

Bases: Visualization

Batch of images.

Source code in ocl/visualization_types.py 
64
65
66
67
68
69
70
71
72
@dataclasses.dataclass
class Images(Visualization):
    """Batch of images."""

    img_tensor: torch.Tensor
    dataformats: str = "NCHW"

    def add_to_experiment(self, experiment: SummaryWriter, tag: str, global_step: int):
        experiment.add_images(**dataclass_to_dict(self), tag=tag, global_step=global_step)

Video dataclass

Bases: Visualization

Batch of videos.

Source code in ocl/visualization_types.py 
75
76
77
78
79
80
81
82
83
@dataclasses.dataclass
class Video(Visualization):
    """Batch of videos."""

    vid_tensor: TensorType["batch_size", "frames", "channels", "height", "width"]  # noqa: F821
    fps: Union[int, float] = 4

    def add_to_experiment(self, experiment: SummaryWriter, tag: str, global_step: int):
        experiment.add_video(**dataclass_to_dict(self), tag=tag, global_step=global_step)

Embedding

Bases: Visualization

Batch of embeddings.

Source code in ocl/visualization_types.py 
86
87
88
89
90
91
92
93
94
95
class Embedding(Visualization):
    """Batch of embeddings."""

    mat: TensorType["batch_size", "feature_dim"]  # noqa: F821
    metadata: Optional[List[Any]] = None
    label_img: Optional[TensorType["batch_size", "channels", "height", "width"]] = None  # noqa: F821
    metadata_header: Optional[List[str]] = None

    def add_to_experiment(self, experiment: SummaryWriter, tag: str, global_step: int):
        experiment.add_embedding(**dataclass_to_dict(self), tag=tag, global_step=global_step)