EvaluatorBuilder

Struct EvaluatorBuilder 

Source
pub struct EvaluatorBuilder<B: Backend, TI, TO: ItemLazy> { /* 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§

Source§

impl<B: Backend, TI, TO: ItemLazy + 'static> EvaluatorBuilder<B, TI, TO>

Source

pub fn new(directory: impl AsRef<Path>) -> Self

Creates a new evaluator builder.

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

pub fn metrics<M: EvalMetricRegistration<TI, TO>>(self, metrics: M) -> Self

Registers numeric test metrics.

Source

pub fn metrics_text<M: EvalTextMetricRegistration<TI, TO>>( self, metrics: M, ) -> Self

Registers text metrics.

Source

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

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

Source

pub fn metric_numeric<Me: Metric + Numeric + 'static>(self, metric: Me) -> Self
where <TO as ItemLazy>::ItemSync: Adaptor<Me::Input>,

Register a numeric test metric.

Source

pub fn metric<Me: Metric + 'static>(self, metric: Me) -> Self
where <TO as ItemLazy>::ItemSync: Adaptor<Me::Input>,

Register a text test metric.

Source

pub fn renderer(self, renderer: Box<dyn MetricsRenderer + 'static>) -> Self

Replace the default CLI renderer with a custom one.

§Arguments
  • renderer - The custom renderer.
Source

pub fn summary(self) -> Self

Enable the evaluation summary report.

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

Source

pub fn build<M>( self, model: M, ) -> Evaluator<EvaluatorComponentTypesMarker<B, M, AsyncProcessorEvaluation<FullEventProcessorEvaluation<TO>>, TI, TO>>
where TI: Send + 'static, M: Module<B> + TestStep<TI, TO> + Display + 'static,

Builds the evaluator.

Auto Trait Implementations§

§

impl<B, TI, TO> Freeze for EvaluatorBuilder<B, TI, TO>

§

impl<B, TI, TO> !RefUnwindSafe for EvaluatorBuilder<B, TI, TO>

§

impl<B, TI, TO> !Send for EvaluatorBuilder<B, TI, TO>

§

impl<B, TI, TO> !Sync for EvaluatorBuilder<B, TI, TO>

§

impl<B, TI, TO> Unpin for EvaluatorBuilder<B, TI, TO>
where B: Unpin, TI: Unpin, TO: Unpin,

§

impl<B, TI, TO> !UnwindSafe for EvaluatorBuilder<B, TI, TO>

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

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
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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

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

Source§

fn vzip(self) -> V