OA LibraryReference

oa::ml::training::TrainingPhase

One consecutive epoch range in a PhaseSchedule.

StRust public API

Declaration

pub struct TrainingPhase { /* private fields */ }

Public Rust declaration.

Public Methods

pub fn id(&self) -> &str

pub const fn epochs(&self) -> u64

pub const fn steps(&self) -> u64

fn clone(&self) -> TrainingPhase

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

fn eq(&self, other: &TrainingPhase) -> bool

Associated Functions

pub fn new(id: impl Into<String>, epochs: u64, steps: u64) -> Result<Self>

Public Method Documentation

pub fn id(
	&self
) -> &str

No public source comment is attached to this declaration.

pub const fn epochs(
	&self
) -> u64

No public source comment is attached to this declaration.

pub const fn steps(
	&self
) -> u64

No public source comment is attached to this declaration.

fn clone(
	&self
) -> TrainingPhase

No public source comment is attached to this declaration.

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

No public source comment is attached to this declaration.

fn eq(
	&self,
	other: &TrainingPhase
) -> bool

No public source comment is attached to this declaration.

pub fn new(
	id: impl Into<String>,
	epochs: u64,
	steps: u64
) -> Result<Self>

No public source comment is attached to this declaration.