pub struct HyperParameterSearchResult<F: Float + Debug + Display + FromPrimitive> { /* private fields */ }Expand description
A hyperparameter search result
Implementations§
Source§impl<F: Float + Debug + Display + FromPrimitive> HyperParameterSearchResult<F>
impl<F: Float + Debug + Display + FromPrimitive> HyperParameterSearchResult<F>
Sourcepub fn new<S: Into<String>>(
metric_name: S,
mode: OptimizationMode,
best_metric: F,
best_params: HashMap<String, F>,
) -> Self
pub fn new<S: Into<String>>( metric_name: S, mode: OptimizationMode, best_metric: F, best_params: HashMap<String, F>, ) -> Self
Create a new hyperparameter search result
Sourcepub fn add_evaluation(&mut self, params: HashMap<String, F>, metric: F)
pub fn add_evaluation(&mut self, params: HashMap<String, F>, metric: F)
Add an evaluation to the history
Sourcepub fn best_metric(&self) -> F
pub fn best_metric(&self) -> F
Get the best metric value
Sourcepub fn best_params(&self) -> &HashMap<String, F>
pub fn best_params(&self) -> &HashMap<String, F>
Get the best hyperparameter values
Trait Implementations§
Source§impl<F: Clone + Float + Debug + Display + FromPrimitive> Clone for HyperParameterSearchResult<F>
impl<F: Clone + Float + Debug + Display + FromPrimitive> Clone for HyperParameterSearchResult<F>
Source§fn clone(&self) -> HyperParameterSearchResult<F>
fn clone(&self) -> HyperParameterSearchResult<F>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl<F> Freeze for HyperParameterSearchResult<F>where
F: Freeze,
impl<F> RefUnwindSafe for HyperParameterSearchResult<F>where
F: RefUnwindSafe,
impl<F> Send for HyperParameterSearchResult<F>where
F: Send,
impl<F> Sync for HyperParameterSearchResult<F>where
F: Sync,
impl<F> Unpin for HyperParameterSearchResult<F>where
F: Unpin,
impl<F> UnwindSafe for HyperParameterSearchResult<F>where
F: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.