Struct syntaxdot_summary::SummaryWriter

pub struct SummaryWriter<W> { /* private fields */ }

TensorBoard summary writer.

Implementations

impl SummaryWriter<BufWriter<File>>

pub fn from_prefix(path: impl Into<PathBuf>) -> Result<Self>

Construct a writer from a path prefix.

For instance, a path such as tensorboard/bert/opt will create the directory tensorboard/bert if it does not exist. Within that directory, it will write to the file opt.out.tfevents.<timestamp>.<hostname>.

impl<W> SummaryWriter<W>where
    W: Write,

pub fn new(write: W) -> Result<Self>

Construct a writer from a Write type.

pub fn write_scalar(
    &mut self,
    tag: impl Into<String>,
    step: i64,
    scalar: f32
) -> Result<()>

Write a scalar.