Share via

TrainerEstimatorBase<TTransformer,TModel> Class

  • Reference

Definition

Namespace:
Microsoft.ML.Trainers
Assembly:
Microsoft.ML.Data.dll
Package:
Microsoft.ML v3.0.1
Package:
Microsoft.ML v1.0.0
Package:
Microsoft.ML v1.1.0
Package:
Microsoft.ML v1.2.0
Package:
Microsoft.ML v1.3.1
Package:
Microsoft.ML v1.4.0
Package:
Microsoft.ML v1.5.5
Package:
Microsoft.ML v1.6.0
Package:
Microsoft.ML v1.7.0
Package:
Microsoft.ML v2.0.0

This represents a basic class for 'simple trainer'. A 'simple trainer' accepts one feature column and one label column, also optionally a weight column. It produces a 'prediction transformer'.

public abstract class TrainerEstimatorBase<TTransformer,TModel> : Microsoft.ML.IEstimator<TTransformer>, Microsoft.ML.Trainers.ITrainerEstimator<TTransformer,TModel> where TTransformer : ISingleFeaturePredictionTransformer<TModel> where TModel : class
type TrainerEstimatorBase<'ransformer, 'Model (requires 'ransformer :> ISingleFeaturePredictionTransformer<'Model> and 'Model : null)> = class
    interface ITrainerEstimator<'ransformer, 'Model (requires 'ransformer :> ISingleFeaturePredictionTransformer<'Model> and 'Model : null)>
    interface IEstimator<'ransformer (requires 'ransformer :> ISingleFeaturePredictionTransformer<'Model>)>
Public MustInherit Class TrainerEstimatorBase(Of TTransformer, TModel)
Implements IEstimator(Of TTransformer), ITrainerEstimator(Of TTransformer, TModel)

Type Parameters

TTransformer
TModel
Inheritance
Object
TrainerEstimatorBase<TTransformer,TModel>
Derived
Implements
IEstimator<TTransformer> ITrainerEstimator<TTransformer,TModel>

Fields

FeatureColumn

The feature column that the trainer expects.
LabelColumn

The label column that the trainer expects. Can be null, which indicates that label is not used for training.
WeightColumn

The weight column that the trainer expects. Can be null, which indicates that weight is not used for training.

Properties

Info

The information about the trainer: whether it benefits from normalization, caching etc.

Methods

Fit(IDataView)

Trains and returns a ITransformer.
GetOutputSchema(SchemaShape)

Extension Methods

AppendCacheCheckpoint<TTrans>(IEstimator<TTrans>, IHostEnvironment)

Append a 'caching checkpoint' to the estimator chain. This will ensure that the downstream estimators will be trained against cached data. It is helpful to have a caching checkpoint before trainers that take multiple data passes.
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