Struct tfrecord::EventWriter

pub struct EventWriter<W> { /* fields omitted */ }

The event writer type.

The EventWriter is initialized by EventWriterInit. It provies a series write_* methods and write_*_async asynchronous analogues to append events to the file recognized by TensorBoard.

The typical usage call the EventWriterInit::from_prefix with the log directory to build a EventWriter.

#![cfg(feature = "full")]
use anyhow::Result;
use std::time::SystemTime;
use tch::{kind::FLOAT_CPU, Tensor};
use tfrecord::EventWriterInit;

fn main() -> Result<()> {
    let mut writer = EventWriterInit::default()
        .from_prefix("log_dir/myprefix-", None)
        .unwrap();

    // step = 0, scalar = 3.14
    writer.write_scalar("my_scalar", 0, 3.14)?;

    // step = 1, specified wall time, histogram of [1, 2, 3, 4]
    writer.write_histogram("my_histogram", (1, SystemTime::now()), vec![1, 2, 3, 4])?;

    // step = 2, specified raw UNIX time in nanoseconds, random tensor of shape [8, 3, 16, 16]
    writer.write_tensor(
        "my_tensor",
        (2, 1.594449514712264e+18),
        Tensor::randn(&[8, 3, 16, 16], FLOAT_CPU),
    )?;

    Ok(())
}

Implementations

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

pub fn write_scalar(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    value: f32
) -> Result<(), Error>

Write a scalar summary.

pub fn write_histogram(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    histogram: impl TryInto<HistogramProto, Error = impl Into<Error>>
) -> Result<(), Error>

Write a histogram summary.

pub fn write_tensor(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    tensor: impl TryInto<TensorProto, Error = impl Into<Error>>
) -> Result<(), Error>

Write a tensor summary.

pub fn write_image(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    image: impl TryInto<Image, Error = impl Into<Error>>
) -> Result<(), Error>

Write an image summary.

pub fn write_image_list(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    images: impl TryInfoImageList<Error = impl Into<Error>>
) -> Result<(), Error>

Write a summary with multiple images.

pub fn write_audio(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    audio: impl TryInto<Audio, Error = impl Into<Error>>
) -> Result<(), Error>

Write an audio summary.

pub fn write_event(&mut self, event: Event) -> Result<(), Error>

Write a custom event.

pub fn flush(&mut self) -> Result<(), Error>

Flush this output stream.

impl<W> EventWriter<W> where
    W: AsyncWriteExt + Unpin, 

pub async fn write_scalar_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    value: f32
) -> Result<(), Error>

Write a scalar summary asynchronously.

pub async fn write_histogram_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    histogram: impl TryInto<HistogramProto, Error = impl Into<Error>>
) -> Result<(), Error>

Write a histogram summary asynchronously.

pub async fn write_tensor_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    tensor: impl TryInto<TensorProto, Error = impl Into<Error>>
) -> Result<(), Error>

Write a tensor summary asynchronously.

pub async fn write_image_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    image: impl TryInto<Image, Error = impl Into<Error>>
) -> Result<(), Error>

Write an image summary asynchronously.

pub async fn write_image_list_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    images: impl TryInfoImageList<Error = impl Into<Error>>
) -> Result<(), Error>

Write a summary with multiple images asynchronously.

pub async fn write_audio_async(
    &mut self,
    tag: impl ToString,
    event_init: impl Into<EventInit>,
    audio: impl TryInto<Audio, Error = impl Into<Error>>
) -> Result<(), Error>

Write an audio summary asynchronously.

pub async fn write_event_async(&mut self, event: Event) -> Result<(), Error>

Write a custom event asynchronously.

pub async fn flush_async(&mut self) -> Result<(), Error>

Flush this output stream asynchronously.

Trait Implementations

impl<W: Clone> Clone for EventWriter<W>

fn clone(&self) -> EventWriter<W>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Debug> Debug for EventWriter<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: PartialEq> PartialEq<EventWriter<W>> for EventWriter<W>

fn eq(&self, other: &EventWriter<W>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EventWriter<W>) -> bool

This method tests for !=.

impl<W> StructuralPartialEq for EventWriter<W>