Skip to main content

CalibrationHistory

Struct CalibrationHistory 

Source
pub struct CalibrationHistory {
    pub schema_version: String,
    pub objective_metric: String,
    pub steps: Vec<StepReport>,
    pub best_loss_mean: Option<f64>,
    pub best_loss_std: Option<f64>,
    pub best_knob_values: BTreeMap<String, KnobValue>,
}
Expand description

Persistable snapshot of a CalibrationLoop’s trajectory.

Fields§

§schema_version: String

Schema version of the file format. See HISTORY_SCHEMA_VERSION.

§objective_metric: String

Objective the loop was minimising — recorded so resume can refuse to load history whose objective differs from the runtime’s (would yield meaningless comparisons).

§steps: Vec<StepReport>

Per-step trajectory in order. Empty until the first loop.step() returns.

§best_loss_mean: Option<f64>

Best loss mean seen so far. None if no step has produced a measurement yet.

§best_loss_std: Option<f64>

Best loss std at the same time best_loss_mean was recorded.

§best_knob_values: BTreeMap<String, KnobValue>

Knob values at the best-loss point. Maps config-tree path → value (stringified via KnobValue::to_yaml_string).

Implementations§

Source§

impl CalibrationHistory

Source

pub fn from_loop(loop_: &CalibrationLoop) -> Self

Build a history snapshot from the current state of a running CalibrationLoop. Cheap — clones the steps Vec

  • best-tracker maps.
Source

pub fn save(&self, path: &Path) -> Result<(), HistoryError>

Serialise to path as pretty-printed JSON. Atomic: writes to path.tmp first then renames, so an interruption mid- write doesn’t corrupt the existing file.

Source

pub fn load(path: &Path) -> Result<Self, HistoryError>

Load from path. Rejects mismatched schema versions so a resume against an incompatible file fails loud rather than silent.

Source

pub fn apply_to(&self, loop_: &mut CalibrationLoop) -> Result<(), HistoryError>

Apply this history to a fresh CalibrationLoop so the loop resumes from where it stopped.

Caller is responsible for ensuring the loop’s objective + knob set + config match what was used when the history was produced; we check the objective metric name as a soft guard but full structural equality on the knob vector is out of scope for the first cut (the design doc deferred strict resume safety to Piece 5).

Trait Implementations§

Source§

impl Clone for CalibrationHistory

Source§

fn clone(&self) -> CalibrationHistory

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 CalibrationHistory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CalibrationHistory

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CalibrationHistory

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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