ITrainerEstimator<TTransformer,TModel> Interface

Definition

Interface for the Trainer Estimator.

public interface ITrainerEstimator<out TTransformer,out TModel> : Microsoft.ML.IEstimator<out TTransformer> where TTransformer : ISingleFeaturePredictionTransformer<out TModel> where TModel : class
type ITrainerEstimator<'ransformer, 'Model (requires 'ransformer :> ISingleFeaturePredictionTransformer<'Model> and 'Model : null)> = interface
    interface IEstimator<'ransformer (requires 'ransformer :> ISingleFeaturePredictionTransformer<'Model>)>
Public Interface ITrainerEstimator(Of Out TTransformer, Out TModel)
Implements IEstimator(Of Out TTransformer)

Type Parameters

TTransformer

The type of the transformer returned by the estimator.

TModel

The type of the model parameters.

Derived
Implements

Properties

Info

Gets the TrainerInfo information about the trainer.

Methods

Fit(IDataView)

Train and return a transformer.

(Inherited from IEstimator<TTransformer>)
GetOutputSchema(SchemaShape)

Schema propagation for estimators. Returns the output schema shape of the estimator, if the input schema shape is like the one provided.

(Inherited from IEstimator<TTransformer>)

Extension Methods

WithOnFitDelegate<TTransformer>(IEstimator<TTransformer>, Action<TTransformer>)

Given an estimator, return a wrapping object that will call a delegate once Fit(IDataView) is called. It is often important for an estimator to return information about what was fit, which is why the Fit(IDataView) method returns a specifically typed object, rather than just a general ITransformer. However, at the same time, IEstimator<TTransformer> are often formed into pipelines with many objects, so we may need to build a chain of estimators via EstimatorChain<TLastTransformer> where the estimator for which we want to get the transformer is buried somewhere in this chain. For that scenario, we can through this method attach a delegate that will be called once fit is called.

Applies to