ITransformer Interface

  • Reference

Definition

Namespace:
Microsoft.ML
Assembly:
Microsoft.ML.Core.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

The transformer is a component that transforms data. It also supports 'schema propagation' to answer the question of 'how will the data with this schema look, after you transform it?'.

public interface ITransformer : Microsoft.ML.ICanSaveModel
type ITransformer = interface
    interface ICanSaveModel
Public Interface ITransformer
Implements ICanSaveModel
Derived
Implements
ICanSaveModel

Properties

IsRowToRowMapper

Whether a call to GetRowToRowMapper(DataViewSchema) should succeed, on an appropriate schema.

Methods

GetOutputSchema(DataViewSchema)

Schema propagation for transformers. Returns the output schema of the data, if the input schema is like the one provided.
GetRowToRowMapper(DataViewSchema)

Constructs a row-to-row mapper based on an input schema. If IsRowToRowMapper is false, then an exception should be thrown. If the input schema is in any way unsuitable for constructing the mapper, an exception should likewise be thrown.
Save(ModelSaveContext) (Inherited from ICanSaveModel)
Transform(IDataView)

Take the data in, make transformations, output the data. Note that IDataView's are lazy, so no actual transformations happen here, just schema validation.

Extension Methods

Preview(ITransformer, IDataView, Int32)

Preview an effect of the transformer on a given data.
Append<TTrans>(ITransformer, TTrans)

Create a new transformer chain, by appending another transformer to the end of this transformer chain.
CreateTimeSeriesEngine<TSrc,TDst>(ITransformer, IHostEnvironment, PredictionEngineOptions)

TimeSeriesPredictionEngine<TSrc,TDst> creates a prediction engine for a time series pipeline. It updates the state of time series model with observations seen at prediction phase and allows checkpointing the model.
CreateTimeSeriesEngine<TSrc,TDst>(ITransformer, IHostEnvironment, Boolean, SchemaDefinition, SchemaDefinition)

TimeSeriesPredictionEngine<TSrc,TDst> creates a prediction engine for a time series pipeline. It updates the state of time series model with observations seen at prediction phase and allows checkpointing the model.

Applies to