TimeSeriesPredictionEngine<TSrc,TDst> Class

Definition

Namespace:

Microsoft.ML.Transforms.TimeSeries

Assembly:

Microsoft.ML.TimeSeries.dll

Package:

Microsoft.ML.TimeSeries v3.0.1

A class that runs the previously trained model (and the preceding transform pipeline) on the in-memory data, one example at a time. This can also be used with trained pipelines that do not end with a predictor: in this case, the 'prediction' will be just the outcome of all the transformations.

public sealed class TimeSeriesPredictionEngine<TSrc,TDst> : Microsoft.ML.PredictionEngineBase<TSrc,TDst> where TSrc : class where TDst : class, new()

type TimeSeriesPredictionEngine<'Src, 'Dst (requires 'Src : null and 'Dst : null and 'Dst : (new : unit -> 'Dst))> = class
    inherit PredictionEngineBase<'Src, 'Dst (requires 'Src : null and 'Dst : null and 'Dst : (new : unit -> 'Dst))>

Public NotInheritable Class TimeSeriesPredictionEngine(Of TSrc, TDst)
Inherits PredictionEngineBase(Of TSrc, TDst)

Type Parameters

TSrc

The user-defined type that holds the example.

TDst

The user-defined type that holds the prediction.

Inheritance

Object

PredictionEngineBase<TSrc,TDst>

TimeSeriesPredictionEngine<TSrc,TDst>

Constructors

TimeSeriesPredictionEngine<TSrc,TDst>(IHostEnvironment, ITransformer, Boolean, SchemaDefinition, SchemaDefinition)

Contructor for creating time series specific prediction engine. It allows the time series model to be updated with the observations seen at prediction time via CheckPoint(IHostEnvironment, String)

Properties

OutputSchema

Provides output schema. (Inherited from PredictionEngineBase<TSrc,TDst>)

Methods

CheckPoint(IHostEnvironment, Stream)	Checkpoints TimeSeriesPredictionEngine<TSrc,TDst> to a Stream with the updated state.
CheckPoint(IHostEnvironment, String)	Checkpoints TimeSeriesPredictionEngine<TSrc,TDst> to disk with the updated state.
Dispose()	(Inherited from PredictionEngineBase<TSrc,TDst>)
Predict(Nullable<Int32>, Nullable<Single>)	Forecasting only task.
Predict(TSrc)	Run prediction pipeline on one example. (Inherited from PredictionEngineBase<TSrc,TDst>)
Predict(TSrc, Nullable<Int32>, Nullable<Single>)	Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation.
Predict(TSrc, TDst)	Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.
Predict(TSrc, TDst, Nullable<Int32>, Nullable<Single>)	Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.