OA LibraryReference

oa::ml::training::TrainingSummary

Final loss, wall-time, device-time, throughput, and run summary.

StRust public API

Declaration

pub struct TrainingSummary { /* private fields */ }

Public Rust declaration.

Public Methods

pub fn set_validation_metric(&mut self, metric: ValidationMetric)

pub fn render_report( &self, state: TrainingSnapshot, config: &ItTrainingConfig, ) -> String

fn on_step_end( &mut self, context: &mut TrainingCallbackContext<'_>, ) -> Result<TrainingControl>

fn on_train_end( &mut self, context: &mut TrainingCallbackContext<'_>, ) -> Result<TrainingControl>

fn on_train_begin( &mut self, _context: &mut TrainingCallbackContext<'_>, ) -> Result<TrainingControl>

fn on_epoch_begin( &mut self, _context: &mut TrainingCallbackContext<'_>, ) -> Result<TrainingControl>

fn on_epoch_end( &mut self, _context: &mut TrainingCallbackContext<'_>, ) -> Result<TrainingControl>

Associated Functions

pub const fn new(track_initial_loss: bool) -> Self

fn default() -> Self

Public Method Documentation

pub fn set_validation_metric(
	&mut self,
	metric: ValidationMetric
)

No public source comment is attached to this declaration.

pub fn render_report(
	&self,
	state: TrainingSnapshot,
	config: &ItTrainingConfig
) -> String

No public source comment is attached to this declaration.

fn on_step_end(
	&mut self,
	context: &mut TrainingCallbackContext<'_>
) -> Result<TrainingControl>

No public source comment is attached to this declaration.

fn on_train_end(
	&mut self,
	context: &mut TrainingCallbackContext<'_>
) -> Result<TrainingControl>

No public source comment is attached to this declaration.

fn on_train_begin(
	&mut self,
	_context: &mut TrainingCallbackContext<'_>
) -> Result<TrainingControl>

No public source comment is attached to this declaration.

fn on_epoch_begin(
	&mut self,
	_context: &mut TrainingCallbackContext<'_>
) -> Result<TrainingControl>

No public source comment is attached to this declaration.

fn on_epoch_end(
	&mut self,
	_context: &mut TrainingCallbackContext<'_>
) -> Result<TrainingControl>

No public source comment is attached to this declaration.

pub const fn new(
	track_initial_loss: bool
) -> Self

No public source comment is attached to this declaration.

fn default() -> Self

No public source comment is attached to this declaration.