Skip to main content

AdaptiveTuner

Struct AdaptiveTuner 

Source
pub struct AdaptiveTuner<A: Float> { /* private fields */ }
Expand description

Adaptive tuner for dynamic optimization

Implementations§

Source§

impl<A: Float + Send + Sync> AdaptiveTuner<A>

Source

pub fn new() -> Self

Create a new adaptive tuner.

The default strategy is greedy hill climbing, which needs no search-space budget beyond the parameters themselves; register those with AdaptiveTuner::add_parameter before calling AdaptiveTuner::tune.

Source

pub fn random_seed(&self) -> u64

Seed the stochastic searches draw from.

Source

pub fn set_random_seed(&mut self, seed: u64)

Set the seed the stochastic searches draw from.

Two AdaptiveTuner::tune calls with the same seed, search space and evaluator produce the same sequence of candidates.

Source

pub fn performance_target(&self) -> A

Performance the search stops at once reached.

Source

pub fn set_performance_target(&mut self, target: A)

Set the performance target.

Source

pub fn strategy(&self) -> &TuningStrategy

Search strategy in use.

Source

pub fn set_strategy(&mut self, strategy: TuningStrategy)

Select the search strategy.

Source

pub fn add_parameter(&mut self, parameter: TunableParameter<A>) -> Result<()>

Register a parameter the search may move.

Source

pub fn parameters(&self) -> &[TunableParameter<A>]

Parameters the search may move.

Source

pub fn current_params(&self) -> &HashMap<String, A>

Best candidate found so far.

Source

pub fn best_performance(&self) -> Option<A>

Performance measured for AdaptiveTuner::current_params.

Source

pub fn tuning_history(&self) -> &[TuningRecord<A>]

Every measurement taken so far, oldest first, bounded to the most recent MAX_TUNING_HISTORY entries.

Source

pub fn total_evaluations(&self) -> usize

Total candidates evaluated over the tuner’s lifetime.

Source

pub fn max_evaluations(&self) -> usize

Evaluation budget for a single AdaptiveTuner::tune call.

Source

pub fn set_max_evaluations(&mut self, max_evaluations: usize)

Set the evaluation budget for a single AdaptiveTuner::tune call.

Source

pub fn tune<F>(&mut self, evaluate: F) -> Result<TuningOutcome<A>>

Run the search behind the configured TuningStrategy.

evaluate measures one candidate parameter set; it is called at most AdaptiveTuner::max_evaluations times. The search maximizes TuningObservation::performance and stops early once a candidate reaches AdaptiveTuner::performance_target.

The previous best candidate is used as the starting point for greedy search, but the recorded best performance is reset first: the objective a caller measures now (a different workload, a different platform) is not comparable with one measured before, and keeping the old number would silently veto every new measurement.

Source

pub fn cheapest_candidate_meeting_target(&self) -> Option<&TuningRecord<A>>

Best resource usage recorded among the candidates that met the performance target, if any.

Surfaces TuningRecord::resource_usage, which is otherwise only reachable by walking the history: the cheapest candidate that still hits the target is usually the one a caller wants to deploy.

Trait Implementations§

Source§

impl<A: Debug + Float> Debug for AdaptiveTuner<A>

Source§

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

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

impl<A: Float + Send + Sync> Default for AdaptiveTuner<A>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<A> Freeze for AdaptiveTuner<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for AdaptiveTuner<A>
where A: RefUnwindSafe,

§

impl<A> Send for AdaptiveTuner<A>
where A: Send,

§

impl<A> Sync for AdaptiveTuner<A>
where A: Sync,

§

impl<A> Unpin for AdaptiveTuner<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for AdaptiveTuner<A>
where A: UnsafeUnpin,

§

impl<A> UnwindSafe for AdaptiveTuner<A>
where A: UnwindSafe,

Blanket Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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