Struct tfrecord::event_writer::EventWriter

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

The event writer.

It provies write_scalar, write_image methods, etc.

It can be built from a writer using from_writer, or write a new file specified by path prefix using from_writer.

use anyhow::Result;
use std::time::SystemTime;
use tch::{kind::FLOAT_CPU, Tensor};
use tfrecord::EventWriter;

let mut writer = EventWriter::from_prefix("log_dir/myprefix-", "", Default::default()).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),
)?;

Implementations

impl EventWriter<BufWriter<File>>

pub fn create<P>(path: P, config: EventWriterConfig) -> Result<Self> where
    P: AsRef<Path>, 

Build a writer writing events to a file.

pub fn from_prefix<'a, 'b, P, S>(
    prefix: P,
    file_name_suffix: S,
    config: EventWriterConfig
) -> Result<EventWriter<BufWriter<File>>> where
    P: Into<Cow<'a, str>>,
    S: Into<Cow<'b, str>>, 

Build a writer writing events to a file, which path is specified by a path prefix and file name suffix.

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

pub fn from_writer(writer: W, config: EventWriterConfig) -> Result<Self> where
    W: Write, 

Build from a writer with Write trait.

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

Write a scalar summary.

pub fn write_histogram(
    &mut self,
    tag: impl ToString,
    event_meta: impl Into<EventMeta>,
    histogram: impl IntoHistogram
) -> Result<()>

Write a histogram summary.

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

Write a tensor summary.

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

Write an image summary.

pub fn write_image_list(
    &mut self,
    tag: impl ToString,
    event_meta: impl Into<EventMeta>,
    images: impl IntoImageList
) -> Result<()>

Write a summary with multiple images.

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

Write an audio summary.

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

Write a custom event.

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

Flush this output stream.

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>