RealmOA Library

oa::ml::training::TrainingSession

Cloneable, thread-safe command and observation handle for one training loop. Attach it to exactly one super::ItTraining instance. Clones may enqueue commands and read bounded evidence from UI, viewer, or service threads.

StRust public API

Declaration

pub struct TrainingSession { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn enqueue(&self, command: TrainingCommand) -> Result<u64>
pub fn pause(&self, expected_revision: u64) -> Result<u64>
pub fn resume(&self, expected_revision: u64) -> Result<u64>
pub fn stop(&self, expected_revision: u64) -> Result<u64>
pub fn checkpoint(&self, expected_revision: u64) -> Result<u64>
pub fn evaluate(&self, expected_revision: u64) -> Result<u64>
pub fn set_parameter( &self, name: impl Into<String>, value: TrainingValue, expected_revision: u64, ) -> Result<u64>
pub fn request_recapture(&self, expected_revision: u64) -> Result<u64>
pub fn request_rebuild( &self, value: TrainingValue, expected_revision: u64, ) -> Result<u64>
pub fn publish_metric(&self, name: impl Into<String>, value: f64)
pub fn parameter(&self, name: &str) -> Option<TrainingValue>
pub fn state(&self) -> TrainingState
pub fn revision(&self) -> u64
pub fn current_snapshot(&self) -> TrainingSessionSnapshot
pub fn latest_snapshot(&self) -> Option<TrainingSessionSnapshot>
pub fn results_after(&self, sequence: u64) -> Vec<TrainingCommandResult>
pub fn take_results(&self) -> Vec<TrainingCommandResult>
fn clone(&self) -> TrainingSession

Associated Functions

pub fn new(config: TrainingSessionConfig) -> Self
fn default() -> Self

Public Method Documentation

pub fn enqueue( &self, command: TrainingCommand ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn pause( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn resume( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn stop( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn checkpoint( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn evaluate( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn set_parameter( &self, name: impl Into<String>, value: TrainingValue, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn request_recapture( &self, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn request_rebuild( &self, value: TrainingValue, expected_revision: u64 ) -> Result<u64>
No public source comment is attached to this declaration.
pub fn publish_metric( &self, name: impl Into<String>, value: f64 )
No public source comment is attached to this declaration.
pub fn parameter( &self, name: &str ) -> Option<TrainingValue>
No public source comment is attached to this declaration.
pub fn state( &self ) -> TrainingState
No public source comment is attached to this declaration.
pub fn revision( &self ) -> u64
No public source comment is attached to this declaration.
pub fn current_snapshot( &self ) -> TrainingSessionSnapshot
No public source comment is attached to this declaration.
pub fn latest_snapshot( &self ) -> Option<TrainingSessionSnapshot>
No public source comment is attached to this declaration.
pub fn results_after( &self, sequence: u64 ) -> Vec<TrainingCommandResult>
No public source comment is attached to this declaration.
pub fn take_results( &self ) -> Vec<TrainingCommandResult>
No public source comment is attached to this declaration.
fn clone( &self ) -> TrainingSession
No public source comment is attached to this declaration.
pub fn new( config: TrainingSessionConfig ) -> Self
No public source comment is attached to this declaration.
fn default() -> Self
No public source comment is attached to this declaration.