Skip to main content

TrainingOutput

Struct TrainingOutput 

Source
pub struct TrainingOutput {
Show 14 fields pub convergence_records: Vec<IterationRecord>, pub final_lower_bound: f64, pub final_upper_bound: Option<f64>, pub final_gap_percent: Option<f64>, pub final_upper_bound_std: Option<f64>, pub final_upper_bound_kind: String, pub iterations_completed: u32, pub converged: bool, pub termination_reason: String, pub total_time_ms: u64, pub cut_stats: RowPoolStatistics, pub cut_selection_records: Vec<RowSelectionRecord>, pub worker_timing_records: Vec<WorkerTimingRecord>, pub training_solve_stats: MetadataTrainingSolveStats,
}
Expand description

Aggregate type carrying all training data needed for output writing.

Constructed by the solver after training completes and passed to write_results. All convergence records and summary statistics are held here so the writer can read them without contacting the solver.

Fields§

§convergence_records: Vec<IterationRecord>

Ordered convergence records — one entry per completed iteration.

§final_lower_bound: f64

Lower bound value reported after the final iteration.

§final_upper_bound: Option<f64>

Upper bound value reported after the final iteration, if available.

None when no upper-bound evaluation was performed.

§final_gap_percent: Option<f64>

Relative gap between final upper and lower bounds as a percentage.

None when the lower bound is zero/negative or final_upper_bound is None.

§final_upper_bound_std: Option<f64>

Standard deviation of the final upper-bound estimate, if available.

None when no upper-bound evaluation was performed or the bound is exact. The value is carried separately in final_upper_bound.

§final_upper_bound_kind: String

Upper-bound regime for the whole run: "statistical" (sampled forward) or "exact" (enumerated forward). Mirrored into training/convergence.parquet and training/metadata.json.

§iterations_completed: u32

Number of iterations completed before the stopping condition was triggered.

§converged: bool

true when training converged within the configured tolerance.

§termination_reason: String

Human-readable description of the rule that terminated training.

§total_time_ms: u64

Total elapsed wall-clock time for the entire training run (ms).

§cut_stats: RowPoolStatistics

Summary row pool statistics for the run.

§cut_selection_records: Vec<RowSelectionRecord>

Per-stage row-selection records for Parquet output.

Empty when row selection is disabled. When non-empty, written to training/cut_selection/iterations.parquet.

§worker_timing_records: Vec<WorkerTimingRecord>

Per-worker timing records for training/timing/iterations.parquet.

Each entry is either a rank-aggregated row (worker_id = None) or a per-worker row (worker_id = Some(w)). Empty when timing data was not collected (e.g. single-threaded runs without the instrumentation wired). Written in iteration-major order: rank-aggregated row first, then per-worker rows sorted by (rank, worker_id).

§training_solve_stats: MetadataTrainingSolveStats

Aggregate solve statistics for the training run.

Default-constructed (all fields None) by producers that do not yet record solve statistics; populated downstream and persisted into training/metadata.json by the metadata writer.

Trait Implementations§

Source§

impl Clone for TrainingOutput

Source§

fn clone(&self) -> TrainingOutput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TrainingOutput

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more