Struct syntaxdot_summary::SummaryWriter

source · [−]

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

Expand description

TensorBoard summary writer.

Implementations

source

impl SummaryWriter<BufWriter<File>>

source

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>.

source

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

source

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

Construct a writer from a Write type.

source

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

Write a scalar.

Auto Trait Implementations

impl<W> RefUnwindSafe for SummaryWriter<W> where
W: RefUnwindSafe,

impl<W> Send for SummaryWriter<W> where
W: Send,

impl<W> Sync for SummaryWriter<W> where
W: Sync,

impl<W> Unpin for SummaryWriter<W> where
W: Unpin,

impl<W> UnwindSafe for SummaryWriter<W> where
W: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct syntaxdot_summary::SummaryWriter

Implementations

impl SummaryWriter<BufWriter<File>>

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

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

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

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

Auto Trait Implementations

impl<W> RefUnwindSafe for SummaryWriter<W> where
W: RefUnwindSafe,

impl<W> Send for SummaryWriter<W> where
W: Send,

impl<W> Sync for SummaryWriter<W> where
W: Sync,

impl<W> Unpin for SummaryWriter<W> where
W: Unpin,

impl<W> UnwindSafe for SummaryWriter<W> where
W: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct syntaxdot_summary::SummaryWriter

Implementations

impl SummaryWriter<BufWriter<File>>

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

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

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

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

Auto Trait Implementations

impl<W> RefUnwindSafe for SummaryWriter<W> where W: RefUnwindSafe,

impl<W> Send for SummaryWriter<W> where W: Send,

impl<W> Sync for SummaryWriter<W> where W: Sync,

impl<W> Unpin for SummaryWriter<W> where W: Unpin,

impl<W> UnwindSafe for SummaryWriter<W> where W: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

impl<W> RefUnwindSafe for SummaryWriter<W> where
W: RefUnwindSafe,

impl<W> Send for SummaryWriter<W> where
W: Send,

impl<W> Sync for SummaryWriter<W> where
W: Sync,

impl<W> Unpin for SummaryWriter<W> where
W: Unpin,

impl<W> UnwindSafe for SummaryWriter<W> where
W: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,