|
| 1 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 | +# |
| 3 | +# This source code is licensed under the MIT license found in the |
| 4 | +# LICENSE file in the root directory of this source tree. |
| 5 | +from __future__ import annotations |
| 6 | + |
| 7 | +import importlib.util |
| 8 | + |
| 9 | +from collections.abc import Sequence |
| 10 | + |
| 11 | +import numpy as np |
| 12 | + |
| 13 | +from torch import Tensor |
| 14 | + |
| 15 | +from .common import Logger |
| 16 | + |
| 17 | +_has_trackio = importlib.util.find_spec("trackio") is not None |
| 18 | +_has_omegaconf = importlib.util.find_spec("omegaconf") is not None |
| 19 | + |
| 20 | + |
| 21 | +class TrackioLogger(Logger): |
| 22 | + """Wrapper for the trackio logger. |
| 23 | +
|
| 24 | + Args: |
| 25 | + exp_name (str): The name of the experiment. |
| 26 | + project (str): The name of the project. |
| 27 | +
|
| 28 | + Keyword Args: |
| 29 | + fps (int, optional): Number of frames per second when recording videos. Defaults to ``30``. |
| 30 | + **kwargs: Extra keyword arguments for ``trackio.init``. |
| 31 | +
|
| 32 | + """ |
| 33 | + |
| 34 | + @classmethod |
| 35 | + def __new__(cls, *args, **kwargs): |
| 36 | + return super().__new__(cls) |
| 37 | + |
| 38 | + def __init__( |
| 39 | + self, |
| 40 | + exp_name: str, |
| 41 | + project: str, |
| 42 | + *, |
| 43 | + video_fps: int = 32, |
| 44 | + **kwargs, |
| 45 | + ) -> None: |
| 46 | + if not _has_trackio: |
| 47 | + raise ImportError("trackio could not be imported") |
| 48 | + |
| 49 | + self.video_fps = video_fps |
| 50 | + self._trackio_kwargs = { |
| 51 | + "name": exp_name, |
| 52 | + "project": project, |
| 53 | + "resume": "allow", |
| 54 | + **kwargs, |
| 55 | + } |
| 56 | + |
| 57 | + super().__init__(exp_name=exp_name, log_dir=project) |
| 58 | + |
| 59 | + def _create_experiment(self): |
| 60 | + """Creates a trackio experiment. |
| 61 | +
|
| 62 | + Args: |
| 63 | + exp_name (str): The name of the experiment. |
| 64 | +
|
| 65 | + Returns: |
| 66 | + A trackio.Experiment object. |
| 67 | + """ |
| 68 | + if not _has_trackio: |
| 69 | + raise ImportError("Trackio is not installed") |
| 70 | + import trackio |
| 71 | + |
| 72 | + return trackio.init(**self._trackio_kwargs) |
| 73 | + |
| 74 | + def log_scalar(self, name: str, value: float, step: int | None = None) -> None: |
| 75 | + """Logs a scalar value to trackio. |
| 76 | +
|
| 77 | + Args: |
| 78 | + name (str): The name of the scalar. |
| 79 | + value (float): The value of the scalar. |
| 80 | + step (int, optional): The step at which the scalar is logged. |
| 81 | + Defaults to None. |
| 82 | + """ |
| 83 | + self.experiment.log({name: value}, step=step) |
| 84 | + |
| 85 | + def log_video(self, name: str, video: Tensor, **kwargs) -> None: |
| 86 | + """Log videos inputs to trackio. |
| 87 | +
|
| 88 | + Args: |
| 89 | + name (str): The name of the video. |
| 90 | + video (Tensor): The video to be logged. |
| 91 | + **kwargs: Other keyword arguments. By construction, log_video |
| 92 | + supports 'step' (integer indicating the step index), 'format' |
| 93 | + (default is 'mp4') and 'fps' (defaults to ``self.video_fps``). Other kwargs are |
| 94 | + passed as-is to the :obj:`experiment.log` method. |
| 95 | + """ |
| 96 | + import trackio |
| 97 | + |
| 98 | + fps = kwargs.pop("fps", self.video_fps) |
| 99 | + format = kwargs.pop("format", "mp4") |
| 100 | + self.experiment.log( |
| 101 | + { |
| 102 | + name: trackio.Video( |
| 103 | + video.numpy().astype(np.uint8), fps=fps, format=format |
| 104 | + ) |
| 105 | + }, |
| 106 | + **kwargs, |
| 107 | + ) |
| 108 | + |
| 109 | + def log_hparams(self, cfg: DictConfig | dict) -> None: # noqa: F821 |
| 110 | + """Logs the hyperparameters of the experiment. |
| 111 | +
|
| 112 | + Args: |
| 113 | + cfg (DictConfig or dict): The configuration of the experiment. |
| 114 | +
|
| 115 | + """ |
| 116 | + if type(cfg) is not dict and _has_omegaconf: |
| 117 | + if not _has_omegaconf: |
| 118 | + raise ImportError( |
| 119 | + "OmegaConf could not be imported. " |
| 120 | + "Cannot log hydra configs without OmegaConf." |
| 121 | + ) |
| 122 | + from omegaconf import OmegaConf |
| 123 | + |
| 124 | + cfg = OmegaConf.to_container(cfg, resolve=True) |
| 125 | + self.experiment.config.update(cfg) |
| 126 | + |
| 127 | + def __repr__(self) -> str: |
| 128 | + return f"TrackioLogger(experiment={self.experiment.__repr__()})" |
| 129 | + |
| 130 | + def log_histogram(self, name: str, data: Sequence, **kwargs): |
| 131 | + """Add histogram to log. |
| 132 | +
|
| 133 | + Args: |
| 134 | + name (str): Data identifier |
| 135 | + data (torch.Tensor, numpy.ndarray): Values to build histogram |
| 136 | +
|
| 137 | + Keyword Args: |
| 138 | + step (int): Global step value to record |
| 139 | + bins (int): Number of bins to use for the histogram |
| 140 | +
|
| 141 | + """ |
| 142 | + import trackio |
| 143 | + |
| 144 | + num_bins = kwargs.pop("bins", None) |
| 145 | + step = kwargs.pop("step", None) |
| 146 | + self.experiment.log( |
| 147 | + {name: trackio.Histogram(data, num_bins=num_bins)}, step=step |
| 148 | + ) |
| 149 | + |
| 150 | + def log_str(self, name: str, value: str, step: int | None = None) -> None: |
| 151 | + """Logs a string value to trackio using a table format for better visualization. |
| 152 | +
|
| 153 | + Args: |
| 154 | + name (str): The name of the string data. |
| 155 | + value (str): The string value to log. |
| 156 | + step (int, optional): The step at which the string is logged. |
| 157 | + Defaults to None. |
| 158 | + """ |
| 159 | + import trackio |
| 160 | + |
| 161 | + # Create a table with a single row |
| 162 | + table = trackio.Table(columns=["text"], data=[[value]]) |
| 163 | + self.experiment.log({name: table}, step=step) |
0 commit comments