EvaluatorBuilder

burn::train

Struct EvaluatorBuilder 

pub struct EvaluatorBuilder<EC>
where
    EC: EvaluatorComponentTypes,
{ /* private fields */ }
Expand description

Struct to configure and create an evaluator.

The generics components of the builder should probably not be set manually, as they are optimized for Rust type inference.

Implementations§

§

impl<B, M> EvaluatorBuilder<EvaluatorComponentTypesMarker<B, M>>
where B: Backend, M: Module<B> + InferenceStep + Display + 'static,

pub fn new( directory: impl AsRef<Path>, ) -> EvaluatorBuilder<EvaluatorComponentTypesMarker<B, M>>

Creates a new evaluator builder.

§Arguments
  • directory - The directory to save the checkpoints.
§

impl<EC> EvaluatorBuilder<EC>
where EC: EvaluatorComponentTypes,

pub fn metrics<Me>(self, metrics: Me) -> EvaluatorBuilder<EC>
where Me: EvalMetricRegistration<EC>,

Registers numeric test metrics.

pub fn metrics_text<Me>(self, metrics: Me) -> EvaluatorBuilder<EC>
where Me: EvalTextMetricRegistration<EC>,

Registers text metrics.

pub fn with_application_logger( self, logger: Option<Box<dyn ApplicationLoggerInstaller>>, ) -> EvaluatorBuilder<EC>

By default, Rust logs are captured and written into evaluation.log. If disabled, standard Rust log handling will apply.

pub fn metric_numeric<Me>(self, metric: Me) -> EvaluatorBuilder<EC>
where Me: Metric + Numeric + 'static, <<<EC as EvaluatorComponentTypes>::Model as InferenceStep>::Output as ItemLazy>::ItemSync: Adaptor<<Me as Metric>::Input>,

Register a numeric test metric.

pub fn metric<Me>(self, metric: Me) -> EvaluatorBuilder<EC>
where Me: Metric + 'static, <<<EC as EvaluatorComponentTypes>::Model as InferenceStep>::Output as ItemLazy>::ItemSync: Adaptor<<Me as Metric>::Input>,

Register a text test metric.

pub fn renderer( self, renderer: Box<dyn MetricsRenderer>, ) -> EvaluatorBuilder<EC>

Replace the default CLI renderer with a custom one.

§Arguments
  • renderer - The custom renderer.

pub fn summary(self) -> EvaluatorBuilder<EC>

Enable the evaluation summary report.

The summary will be displayed at the end of .eval().

pub fn build( self, model: <EC as EvaluatorComponentTypes>::Model, ) -> Evaluator<EC>

Builds the evaluator.

Auto Trait Implementations§

§

impl<EC> Freeze for EvaluatorBuilder<EC>

§

impl<EC> !RefUnwindSafe for EvaluatorBuilder<EC>

§

impl<EC> !Send for EvaluatorBuilder<EC>

§

impl<EC> !Sync for EvaluatorBuilder<EC>

§

impl<EC> Unpin for EvaluatorBuilder<EC>

§

impl<EC> !UnwindSafe for EvaluatorBuilder<EC>

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

§

impl<T> IntoComptime for T

§

fn comptime(self) -> Self

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more