Skip to main content

StudyBuilder

Struct StudyBuilder 

Source
pub struct StudyBuilder { /* private fields */ }
Expand description

Fluent builder for a Study, with sensible defaults: a RandomSampler, a NopPruner, an InMemoryStorage, and Direction::Minimize. Override any of them before calling StudyBuilder::build.

Implementations§

Source§

impl StudyBuilder

Source

pub fn new(name: impl Into<String>) -> Self

Start building a study with the given name.

Source

pub fn direction(self, direction: Direction) -> Self

Set the optimization direction (default Direction::Minimize).

Source

pub fn sampler(self, sampler: impl Sampler + 'static) -> Self

Set the search algorithm (default RandomSampler).

Source

pub fn pruner(self, pruner: impl Pruner + 'static) -> Self

Set the early-stopping policy (default NopPruner).

Source

pub fn storage(self, storage: impl Storage + 'static) -> Self

Set the storage backend (default InMemoryStorage).

Source

pub fn build(self) -> Result<Study, HyperoptError>

Assemble the Study, applying defaults for anything not set.

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