TrainerEstimatorBase<TTransformer,TModel> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 : classtype 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
-
TrainerEstimatorBase<TTransformer,TModel>
- Derived
- Implements
Fields
| FeatureColumn |
The feature column that the trainer expects. |
| LabelColumn |
The label column that the trainer expects. Can be |
| WeightColumn |
The weight column that the trainer expects. Can be |
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. |