Skip to main content

CalibrationLoop

datasynth_eval::calibration

Struct CalibrationLoop

pub struct CalibrationLoop {
    pub objective: CalibrationObjective,
    pub knobs: Vec<CalibrationKnob>,
    pub config: CalibrationConfig,
    pub history: Vec<StepReport>,
    pub best_loss: Option<(f64, f64)>,
    pub best_knob_values: BTreeMap<String, KnobValue>,
    /* private fields */
}

Expand description

The iteration controller. Owns the knobs, objective, config, and the accumulated history.

Fields§

§objective: CalibrationObjective§knobs: Vec<CalibrationKnob>§config: CalibrationConfig§history: Vec<StepReport>§best_loss: Option<(f64, f64)>

Best (mean, std) seen so far.

§best_knob_values: BTreeMap<String, KnobValue>

Knob values when best_loss was observed.

Implementations§

impl CalibrationLoop

pub fn new( objective: CalibrationObjective, knobs: Vec<CalibrationKnob>, config: CalibrationConfig, ) -> Self

pub fn step<E: Evaluator, P: Proposer>( &mut self, evaluator: &E, proposer: &mut P, ) -> Result<&StepReport, EvaluatorError>

Run one step. Returns the resulting StepReport which is also appended to self.history.

pub fn run<E: Evaluator, P: Proposer>( &mut self, evaluator: &E, proposer: &mut P, ) -> Result<&[StepReport], EvaluatorError>

Run until convergence, patience exhaustion, max-iter, or proposer exhaustion. Returns the final history.

Auto Trait Implementations§

impl Freeze for CalibrationLoop

impl RefUnwindSafe for CalibrationLoop

impl Send for CalibrationLoop

impl Sync for CalibrationLoop

impl Unpin for CalibrationLoop

impl UnsafeUnpin for CalibrationLoop

impl UnwindSafe for CalibrationLoop

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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