Skip to main content

TuneObjective

Enum TuneObjective 

Source
pub enum TuneObjective {
    Mrr,
    Top1,
    CoveredMrr,
    Top1AtMinCoverage,
    SuccessWeightedMrr,
    SuccessWeightedTop1,
}
Expand description

Which held-out metric tune ranks candidates by. See each variant’s doc comment; CoveredMrr is the recommended default – optimizing Mrr alone tends to pick configs that abstain (report no candidate) except when very confident, while optimizing coverage alone tolerates a sloppy prior. CoveredMrr penalizes both.

Variants§

§

Mrr

mean_reciprocal_rank, among evaluated (covered) test observations only.

§

Top1

top1_hit_rate, among evaluated (covered) test observations only.

§

CoveredMrr

covered_fraction * mean_reciprocal_rank – MRR averaged across all test observations, treating an uncovered one as contributing 0.

§

Top1AtMinCoverage

Identical to Top1; choosing this objective requires TuneConstraints::min_covered_fraction to also be set, so the coverage floor lives in one place (constraints) instead of being duplicated inside the objective itself.

§

SuccessWeightedMrr

EvalReport::success_weighted_mean_reciprocal_rank – like Mrr, but a failed or unrecorded-outcome test observation contributes nothing, so this favors configs that agree with actions that actually worked.

§

SuccessWeightedTop1

EvalReport::success_weighted_top1_hit_rate, the same idea applied to Top1.

Trait Implementations§

Source§

impl Clone for TuneObjective

Source§

fn clone(&self) -> TuneObjective

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 Copy for TuneObjective

Source§

impl Debug for TuneObjective

Source§

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

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

impl Eq for TuneObjective

Source§

impl PartialEq for TuneObjective

Source§

fn eq(&self, other: &TuneObjective) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for TuneObjective

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
Source§

impl StructuralPartialEq for TuneObjective

Auto Trait Implementations§

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