Module ai.utils.logging.field

Expand source code 
from ._base import Base
from ._scalar import Scalar
from ._frequency import Frequency


__all__ = ["Base", "Scalar", "Frequency"]

Classes

class Base (name: str)

Base logging field.

Args

name : str
Name of the logging field.

Ancestors

  • abc.ABC

Subclasses

Instance variables

var name : str
Expand source code 
@property
def name(self) -> str:
    return self._name
var writer : torch.utils.tensorboard.writer.SummaryWriter
Expand source code 
@property
def writer(self) -> torch.utils.tensorboard.writer.SummaryWriter:
    return self._writer

Methods

def log(self, value: Any)

Logs the item to the given writer.

Expand source code 
@abc.abstractmethod
def log(self, value: Any):
    """Logs the item to the given writer."""
    pass
class Frequency (name: str, log_period: float)

Field logging frequency of occurances.

Args

name : str
Name of logging field.
log_period : float
Period (seconds) between logs.

Ancestors

Inherited members

class Scalar (name: str)

Field logging scalar values.

Args

name : str
Name of the logging field.

Ancestors

Inherited members