Struct burn::train::Learner

pub struct Learner<LC>where
    LC: LearnerComponents,
{ /* private fields */ }

Expand description

Learner struct encapsulating all components necessary to train a Neural Network model.

To create a learner, use the builder struct.

Implementations§

§

impl<LC> Learner<LC>
where LC: LearnerComponents,

pub fn fit<InputTrain, InputValid, OutputTrain, OutputValid>( self, dataloader_train: Arc<dyn DataLoader<InputTrain>>, dataloader_valid: Arc<dyn DataLoader<InputValid>>, ) -> <LC as LearnerComponents>::Model
where InputTrain: Send + 'static, InputValid: Send, OutputTrain: Send + 'static, OutputValid: Send, <LC as LearnerComponents>::Model: TrainStep<InputTrain, OutputTrain>, <<LC as LearnerComponents>::Model as AutodiffModule<<LC as LearnerComponents>::Backend>>::InnerModule: ValidStep<InputValid, OutputValid>, <LC as LearnerComponents>::EventProcessor: EventProcessor<ItemTrain = OutputTrain, ItemValid = OutputValid>,

Fits the model.

§Arguments

dataloader_train - The training dataloader.
dataloader_valid - The validation dataloader.

§Returns

The fitted model.

Auto Trait Implementations§

§

impl<LC> Freeze for Learner<LC>
where <LC as LearnerComponents>::Model: Freeze, <LC as LearnerComponents>::Optimizer: Freeze, <LC as LearnerComponents>::LrScheduler: Freeze, <LC as LearnerComponents>::EventProcessor: Freeze, <LC as LearnerComponents>::CheckpointerModel: Freeze, <LC as LearnerComponents>::CheckpointerOptimizer: Freeze, <LC as LearnerComponents>::CheckpointerLrScheduler: Freeze, <LC as LearnerComponents>::CheckpointerStrategy: Freeze,

§

impl<LC> Unpin for Learner<LC>
where <LC as LearnerComponents>::Model: Unpin, <LC as LearnerComponents>::Optimizer: Unpin, <LC as LearnerComponents>::LrScheduler: Unpin, <LC as LearnerComponents>::EventProcessor: Unpin, <LC as LearnerComponents>::CheckpointerModel: Unpin, <LC as LearnerComponents>::CheckpointerOptimizer: Unpin, <LC as LearnerComponents>::CheckpointerLrScheduler: Unpin, <LC as LearnerComponents>::CheckpointerStrategy: Unpin, <<LC as LearnerComponents>::Backend as Backend>::Device: Unpin,

§

impl<LC> !UnwindSafe for Learner<LC>

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

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

§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into 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

§