pub struct HyperParameterTuner<F: Float + Debug + Display + FromPrimitive> { /* private fields */ }Expand description
A hyperparameter tuner
Implementations§
Source§impl<F: Float + Debug + Display + FromPrimitive> HyperParameterTuner<F>
impl<F: Float + Debug + Display + FromPrimitive> HyperParameterTuner<F>
Sourcepub fn new<S: Into<String>>(
params: Vec<HyperParameter<F>>,
metric_name: S,
maximize: bool,
max_evals: usize,
) -> Result<Self>
pub fn new<S: Into<String>>( params: Vec<HyperParameter<F>>, metric_name: S, maximize: bool, max_evals: usize, ) -> Result<Self>
Create a new hyperparameter tuner
Sourcepub fn get_current_params(&self) -> HashMap<String, F>
pub fn get_current_params(&self) -> HashMap<String, F>
Get the current hyperparameter values
Sourcepub fn set_params(&mut self, params: &HashMap<String, F>) -> Result<()>
pub fn set_params(&mut self, params: &HashMap<String, F>) -> Result<()>
Set hyperparameter values
Sourcepub fn update(&mut self, metricvalue: F) -> Result<bool>
pub fn update(&mut self, metricvalue: F) -> Result<bool>
Update the tuner with an evaluation result
Sourcepub fn random_params(&self) -> HashMap<String, F>
pub fn random_params(&self) -> HashMap<String, F>
Get a random set of hyperparameters
Sourcepub fn random_search<FnEval>(
&mut self,
eval_fn: FnEval,
) -> Result<HyperParameterSearchResult<F>>
pub fn random_search<FnEval>( &mut self, eval_fn: FnEval, ) -> Result<HyperParameterSearchResult<F>>
Run random search for hyperparameter tuning
Sourcepub fn best_params(&self) -> &HashMap<String, F>
pub fn best_params(&self) -> &HashMap<String, F>
Get the best parameters found so far
Sourcepub fn best_value(&self) -> Option<F>
pub fn best_value(&self) -> Option<F>
Get the best metric value found so far
Trait Implementations§
Auto Trait Implementations§
impl<F> Freeze for HyperParameterTuner<F>where
F: Freeze,
impl<F> RefUnwindSafe for HyperParameterTuner<F>where
F: RefUnwindSafe,
impl<F> Send for HyperParameterTuner<F>where
F: Send,
impl<F> Sync for HyperParameterTuner<F>where
F: Sync,
impl<F> Unpin for HyperParameterTuner<F>where
F: Unpin,
impl<F> UnwindSafe for HyperParameterTuner<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> 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.