Skip to main content
Ctrl+K
sktime  documentation - Home sktime  documentation - Home
  • Get Started
  • Documentation
  • Installation
  • Estimator Overview
  • API Reference
    • Get Involved
    • Development
    • About
    • Notebook Examples
  • GitHub
  • Discord
  • LinkedIn
  • Get Started
  • Documentation
  • Installation
  • Estimator Overview
  • API Reference
  • Get Involved
  • Development
  • About
  • Notebook Examples
  • GitHub
  • Discord
  • LinkedIn

Section Navigation

  • Data Format Specifications
    • ScitypeSeries
    • ScitypePanel
    • ScitypeHierarchical
    • ScitypeTable
    • SeriesPdDataFrame
    • SeriesPdSeries
    • SeriesNp2D
    • SeriesDask
    • SeriesPolarsEager
    • SeriesGluontsList
    • SeriesGluontsPandas
    • PanelPdMultiIndex
    • PanelNp3D
    • PanelDfList
    • PanelDask
    • PanelPolarsEager
    • PanelGluontsList
    • PanelGluontsPandas
    • HierarchicalPdMultiIndex
    • HierarchicalDask
    • HierarchicalPolarsEager
    • TablePdDataFrame
    • TablePdSeries
    • TableNp1D
    • TableNp2D
    • TableListOfDict
    • TablePolarsEager
    • ts File Format v1.0
  • Forecasting
    • BaseForecaster
    • ForecastingHorizon
    • make_pipeline
    • TransformedTargetForecaster
    • ForecastingPipeline
    • ColumnEnsembleForecaster
    • MultiplexForecaster
    • ForecastX
    • ForecastByLevel
    • TransformSelectForecaster
    • GroupbyCategoryForecaster
    • HierarchyEnsembleForecaster
    • Permute
    • FhPlexForecaster
    • IgnoreX
    • FallbackForecaster
    • YfromX
    • make_reduction
    • DirectTabularRegressionForecaster
    • DirectTimeSeriesRegressionForecaster
    • MultioutputTabularRegressionForecaster
    • MultioutputTimeSeriesRegressionForecaster
    • RecursiveTabularRegressionForecaster
    • RecursiveTimeSeriesRegressionForecaster
    • DirRecTabularRegressionForecaster
    • DirRecTimeSeriesRegressionForecaster
    • DirectReductionForecaster
    • RecursiveReductionForecaster
    • SkforecastAutoreg
    • SkforecastRecursive
    • DartsRegressionModel
    • DartsLinearRegressionModel
    • DartsXGBModel
    • NaiveForecaster
    • ForecastKnownValues
    • SquaringResiduals
    • NaiveVariance
    • ConformalIntervals
    • BaggingForecaster
    • EnbPIForecaster
    • BoxCoxBiasAdjustedForecaster
    • TrendForecaster
    • PolynomialTrendForecaster
    • STLForecaster
    • CurveFitForecaster
    • ProphetPiecewiseLinearTrendForecaster
    • SplineTrendForecaster
    • StatsForecastMSTL
    • ExponentialSmoothing
    • AutoETS
    • StatsForecastAutoETS
    • StatsForecastAutoCES
    • ThetaForecaster
    • StatsForecastAutoTheta
    • AutoREG
    • ARIMA
    • StatsModelsARIMA
    • SARIMAX
    • VAR
    • VARReduce
    • VARMAX
    • VECM
    • AutoARIMA
    • StatsForecastAutoARIMA
    • StatsForecastARCH
    • StatsForecastGARCH
    • ARCH
    • ARDL
    • BATS
    • TBATS
    • StatsForecastAutoTBATS
    • Prophet
    • Prophetverse
    • HierarchicalProphet
    • UnobservedComponents
    • DynamicFactor
    • LTSFLinearForecaster
    • LTSFDLinearForecaster
    • LTSFNLinearForecaster
    • LTSFTransformerForecaster
    • SCINetForecaster
    • CINNForecaster
    • NeuralForecastRNN
    • NeuralForecastLSTM
    • PytorchForecastingTFT
    • PytorchForecastingDeepAR
    • PytorchForecastingNHiTS
    • PytorchForecastingNBeats
    • PyKANForecaster
    • RBFForecaster
    • HFTransformersForecaster
    • ChronosForecaster
    • MOIRAIForecaster
    • TimesFMForecaster
    • TinyTimeMixerForecaster
    • Croston
    • EnsembleForecaster
    • AutoEnsembleForecaster
    • StackingForecaster
    • ReconcilerForecaster
    • OnlineEnsembleForecaster
    • NormalHedgeEnsemble
    • NNLSEnsemble
    • UpdateEvery
    • UpdateRefitsEvery
    • DontUpdate
    • HCrystalBallAdapter
    • ForecastingGridSearchCV
    • ForecastingRandomizedSearchCV
    • ForecastingSkoptSearchCV
    • ForecastingOptunaSearchCV
    • evaluate
  • Time series transformations
    • TransformerPipeline
    • FeatureUnion
    • ColumnEnsembleTransformer
    • FitInTransform
    • InvertTransform
    • YtoX
    • IxToX
    • ColumnwiseTransformer
    • TransformByLevel
    • FunctionTransformer
    • MultiplexTransformer
    • OptionalPassthrough
    • TransformIf
    • Id
    • Logger
    • Tabularizer
    • TimeBinner
    • TabularToSeriesAdaptor
    • PandasTransformAdaptor
    • SummaryTransformer
    • WindowSummarizer
    • SplitterSummarizer
    • DerivativeSlopeTransformer
    • PlateauFinder
    • RandomIntervalFeatureExtractor
    • FittedParamExtractor
    • ADICVTransformer
    • ShapeletTransform
    • RandomShapeletTransform
    • ShapeletTransformPyts
    • Rocket
    • MiniRocket
    • MiniRocketMultivariate
    • MiniRocketMultivariateVariable
    • DWTTransformer
    • MatrixProfile
    • SFA
    • HurstExponentTransformer
    • SignatureMoments
    • SignatureTransformer
    • TSFreshRelevantFeatureExtractor
    • TSFreshFeatureExtractor
    • Catch22
    • Catch22Wrapper
    • Lag
    • ReducerTransform
    • BoxCoxTransformer
    • LogTransformer
    • ScaledLogitTransformer
    • CosineTransformer
    • ExponentTransformer
    • SqrtTransformer
    • ScaledAsinhTransformer
    • Detrender
    • Deseasonalizer
    • ConditionalDeseasonalizer
    • STLTransformer
    • MSTL
    • VmdTransformer
    • ClearSky
    • Filter
    • BKFilter
    • CFFilter
    • HPFilter
    • KalmanFilterTransformerPK
    • KalmanFilterTransformerFP
    • ThetaLinesTransformer
    • Bollinger
    • Differencer
    • SlopeTransformer
    • KinematicFeatures
    • TimeBinAggregate
    • TSInterpolator
    • IntervalSegmenter
    • RandomIntervalSegmenter
    • DilationMappingTransformer
    • PAA
    • SAX
    • PAAlegacy
    • SAXlegacy
    • Imputer
    • DropNA
    • DateTimeFeatures
    • HolidayFeatures
    • CountryHolidaysTransformer
    • FinancialHolidaysTransformer
    • TimeSince
    • FourierFeatures
    • FourierTransform
    • RBFTransformer
    • PeakTimeFeature
    • AutoCorrelationTransformer
    • PartialAutoCorrelationTransformer
    • MatrixProfileTransformer
    • HOG1DTransformer
    • SubsequenceExtractionTransformer
    • ColumnConcatenator
    • InvertAugmenter
    • RandomSamplesAugmenter
    • ReverseAugmenter
    • WhiteNoiseAugmenter
    • FeatureSelection
    • ElbowClassSum
    • ElbowClassPairwise
    • ColumnSelect
    • IndexSubset
    • TemporianTransformer
    • PaddingTransformer
    • TruncationTransformer
    • PCATransformer
    • MovingBlockBootstrapTransformer
    • SplitterBootstrapTransformer
    • STLBootstrapTransformer
    • Merger
    • HampelFilter
    • ClaSPTransformer
    • Aggregator
    • Reconciler
  • Time series classification
    • ClassifierPipeline
    • ColumnEnsembleClassifier
    • SklearnClassifierPipeline
    • MultiplexClassifier
    • TSCGridSearchCV
    • BaggingClassifier
    • ComposableTimeSeriesForestClassifier
    • WeightedEnsembleClassifier
    • CNNClassifier
    • CNTCClassifier
    • FCNClassifier
    • LSTMFCNClassifier
    • GRUClassifier
    • GRUFCNNClassifier
    • InceptionTimeClassifier
    • MACNNClassifier
    • MLPClassifier
    • MCDCNNClassifier
    • MVTSTransformerClassifier
    • ResNetClassifier
    • SimpleRNNClassifier
    • TapNetClassifier
    • BOSSVSClassifierPyts
    • BOSSEnsemble
    • ContractableBOSS
    • IndividualBOSS
    • IndividualTDE
    • MUSE
    • TemporalDictionaryEnsemble
    • WEASEL
    • ElasticEnsemble
    • KNeighborsTimeSeriesClassifier
    • KNeighborsTimeSeriesClassifierPyts
    • KNeighborsTimeSeriesClassifierTslearn
    • ProximityForest
    • ProximityStump
    • ProximityTree
    • ShapeDTW
    • DummyClassifier
    • ProbabilityThresholdEarlyClassifier
    • TEASER
    • Catch22Classifier
    • FreshPRINCE
    • MatrixProfileClassifier
    • RandomIntervalClassifier
    • SignatureClassifier
    • SummaryClassifier
    • TSFreshClassifier
    • HIVECOTEV1
    • HIVECOTEV2
    • CanonicalIntervalForest
    • DrCIF
    • RandomIntervalSpectralEnsemble
    • SupervisedTimeSeriesForest
    • TimeSeriesForestClassifier
    • TimeSeriesSVC
    • TimeSeriesSVCTslearn
    • Arsenal
    • RocketClassifier
    • ShapeletTransformClassifier
    • ShapeletLearningClassifierPyts
    • ShapeletLearningClassifierTslearn
    • MrSEQL
    • MrSQM
    • ContinuousIntervalTree
    • RotationForest
    • BaseClassifier
    • BaseDeepClassifier
    • BaseEarlyClassifier
  • Time series regression
    • RegressorPipeline
    • SklearnRegressorPipeline
    • MultiplexRegressor
    • TSRGridSearchCV
    • ComposableTimeSeriesForestRegressor
    • CNNRegressor
    • CNTCRegressor
    • FCNRegressor
    • InceptionTimeRegressor
    • LSTMFCNRegressor
    • MACNNRegressor
    • MCDCNNRegressor
    • MLPRegressor
    • SimpleRNNRegressor
    • ResNetRegressor
    • TapNetRegressor
    • KNeighborsTimeSeriesRegressor
    • DummyRegressor
    • TimeSeriesForestRegressor
    • TimeSeriesSVRTslearn
    • RocketRegressor
    • BaseRegressor
    • BaseDeepRegressor
  • Time series clustering
    • TimeSeriesKMeans
    • TimeSeriesKMeansTslearn
    • TimeSeriesKMedoids
    • TimeSeriesKShapes
    • TimeSeriesKernelKMeans
    • TimeSeriesDBSCAN
    • TimeSeriesKvisibility
    • STDBSCAN
    • BaseClusterer
    • BaseTimeSeriesLloyds
  • Time series distances/kernels
    • PwTrafoPanelPipeline
    • CombinedDistance
    • IndepDist
    • AggrDist
    • FlatDist
    • DistFromAligner
    • KernelFromDist
    • DistFromKernel
    • AggrDist
    • FlatDist
    • DtwDist
    • DtwPythonDist
    • DtwDistTslearn
    • SoftDtwDistTslearn
    • DtwDtaidistUniv
    • DtwDtaidistMultiv
    • CtwDistTslearn
    • LuckyDtwDist
    • DistFromAligner
    • EditDist
    • LcssTslearn
    • AggrDist
    • FlatDist
    • GAKernel
    • SignatureKernel
    • BasePairwiseTransformerPanel
    • ScipyDist
    • BasePairwiseTransformer
    • ddtw_distance
    • dtw_distance
    • edr_distance
    • erp_distance
    • euclidean_distance
    • lcss_distance
    • msm_distance
    • pairwise_distance
    • squared_distance
    • twe_distance
    • wddtw_distance
    • wdtw_distance
  • Parameter estimation
    • ParamFitterPipeline
    • FunctionParamFitter
    • PluginParamsForecaster
    • PluginParamsTransformer
    • FixedParams
    • SeasonalityACF
    • SeasonalityACFqstat
    • SeasonalityPeriodogram
    • StationarityADF
    • StationarityKPSS
    • StationarityADFArch
    • StationarityDFGLS
    • StationarityPhillipsPerron
    • StationarityKPSSArch
    • StationarityZivotAndrews
    • StationarityVarianceRatio
    • ARLagOrderSelector
  • Performance metrics
    • MeanAbsoluteScaledError
    • MedianAbsoluteScaledError
    • MeanSquaredScaledError
    • MedianSquaredScaledError
    • MeanAbsoluteError
    • MeanSquaredError
    • MedianAbsoluteError
    • MedianSquaredError
    • GeometricMeanAbsoluteError
    • GeometricMeanSquaredError
    • MeanAbsolutePercentageError
    • MedianAbsolutePercentageError
    • MeanSquaredPercentageError
    • MedianSquaredPercentageError
    • MeanRelativeAbsoluteError
    • MedianRelativeAbsoluteError
    • GeometricMeanRelativeAbsoluteError
    • GeometricMeanRelativeSquaredError
    • MeanAsymmetricError
    • MeanLinexError
    • RelativeLoss
    • make_forecasting_scorer
    • mean_absolute_scaled_error
    • median_absolute_scaled_error
    • mean_squared_scaled_error
    • median_squared_scaled_error
    • mean_absolute_error
    • mean_squared_error
    • median_absolute_error
    • median_squared_error
    • geometric_mean_absolute_error
    • geometric_mean_squared_error
    • mean_absolute_percentage_error
    • median_absolute_percentage_error
    • mean_squared_percentage_error
    • median_squared_percentage_error
    • mean_relative_absolute_error
    • median_relative_absolute_error
    • geometric_mean_relative_absolute_error
    • geometric_mean_relative_squared_error
    • mean_asymmetric_error
    • mean_linex_error
    • relative_loss
    • PinballLoss
    • EmpiricalCoverage
    • ConstraintViolation
    • AUCalibration
    • CRPS
    • LogLoss
    • SquaredDistrLoss
    • DirectedChamfer
    • DirectedHausdorff
    • DetectionCount
    • WindowedF1Score
    • RandIndex
    • count_error
    • hausdorff_error
    • prediction_ratio
  • Splitters
    • temporal_train_test_split
    • CutoffSplitter
    • SingleWindowSplitter
    • SlidingWindowSplitter
    • ExpandingWindowSplitter
    • ExpandingCutoffSplitter
    • ExpandingGreedySplitter
    • ExpandingSlidingWindowSplitter
    • TemporalTrainTestSplitter
    • Repeat
    • SameLocSplitter
    • TestPlusTrainSplitter
    • InstanceSplitter
  • Time series alignment
    • AlignerNaive
    • AlignerDTW
    • AlignerDTWfromDist
    • AlignerDtwDtai
    • AlignerDtwNumba
    • AlignerLuckyDtw
    • AlignerEditNumba
  • Time series detection tasks
    • DetectorPipeline
    • DetectorAsTransformer
    • MovingWindow
    • PELT
    • SeededBinarySegmentation
    • DummyRegularChangePoints
    • ZeroChangePoints
    • SubLOF
    • PyODDetector
    • DummyRegularAnomalies
    • ZeroAnomalies
    • ThresholdDetector
    • StatThresholdAnomaliser
    • CircularBinarySegmentation
    • CAPA
    • MVCAPA
    • ZeroSegments
    • ThresholdDetector
    • ClaSPSegmentation
    • EAgglo
    • GaussianHMM
    • GMMHMM
    • GreedyGaussianSegmentation
    • HMM
    • InformationGainSegmentation
    • PoissonHMM
    • STRAY
    • ClusterSegmenter
    • WindowSegmenter
    • ZeroSegments
  • Datasets
    • Airline
    • Longley
    • Lynx
    • M5Dataset
    • Macroeconomic
    • ShampooSales
    • Solar
    • USChange
    • ArrowHead
    • BasicMotions
    • GunPoint
    • ItalyPowerDemand
    • JapaneseVowels
    • OSULeaf
    • PLAID
    • Tecator
    • load_forecastingdata
    • load_fpp3
    • load_m5
    • load_UCR_UEA_dataset
    • load_airline
    • load_longley
    • load_lynx
    • load_macroeconomic
    • load_shampoo_sales
    • load_solar
    • load_uschange
    • load_acsf1
    • load_arrow_head
    • load_basic_motions
    • load_gunpoint
    • load_italy_power_demand
    • load_japanese_vowels
    • load_macroeconomic
    • load_osuleaf
    • load_tecator
    • load_hierarchical_sales_toydata
    • load_from_arff_to_dataframe
    • load_from_tsfile
    • load_from_tsfile_to_dataframe
    • load_from_ucr_tsv_to_dataframe
    • load_from_long_to_dataframe
    • load_tsf_to_dataframe
    • write_panel_to_tsfile
    • write_dataframe_to_tsfile
    • write_ndarray_to_tsfile
    • write_tabular_transformation_to_arff
    • write_results_to_uea_format
  • Deployment and MLOps
    • get_default_pip_requirements
    • get_default_conda_env
    • save_model
    • log_model
    • load_model
  • Utility functions
    • convert_to
    • convert
    • check_raise
    • check_is_mtype
    • check_is_scitype
    • mtype
    • scitype
    • mtype_to_scitype
    • scitype_to_mtype
    • make_pipeline
    • sklearn_to_sktime
    • all_estimators
    • all_tags
    • check_tag_is_valid
    • craft
    • deps
    • imports
    • plot_series
    • plot_lags
    • plot_correlations
    • check_estimator
  • Base
    • BaseObject
    • BaseEstimator
  • Exceptions
    • NotEvaluatedError
    • NotFittedError
    • FitFailedWarning
  • Object and estimator tags
    • all_tags
    • all_estimators
    • object_type
    • maintainers
    • authors
    • python_version
    • python_dependencies
    • env_marker
    • requires_cython
    • capability__exogeneous
    • capability__insample
    • capability__pred_int
    • capability__pred_int__insample
    • capability__missing_values
    • capability__categorical_in_X
    • requires_fh_in_fit
    • fit_is_empty
    • capability__multivariate
    • capability__multioutput
    • capability__missing_values
    • capability__unequal_length
    • capability__predict_proba
    • capability__feature_importance
    • capability__contractable
    • capability__train_estimate
    • scitype__transform_input
    • scitype__transform_output
    • scitype__transform_labels
    • requires_x
    • requires_y
    • capability__missing_values
    • capability__unequal_length
    • capability__inverse_transform
    • capability__inverse_transform__exact
    • capability__inverse_transform__range
    • fit_is_empty
    • transform_returns_same_time_index
    • task
    • learning_type
    • capability__update
    • capability__multivariate
    • capability__missing_values
    • x_inner_mtype
    • y_inner_mtype
    • visual_block_kind
  • Pipeline
    • make_pipeline
    • Pipeline
  • Benchmarking
    • BaseBenchmark
    • ForecastingBenchmark
    • BaseMetric
    • BaseResults
    • BaseDataset
    • HDDBaseResults
    • HDDBaseDataset
    • UEADataset
    • RAMDataset
    • Evaluator
    • run_clustering_experiment
    • load_and_run_clustering_experiment
    • run_classification_experiment
    • load_and_run_classification_experiment
    • Orchestrator
    • RAMResults
    • HDDResults
    • BaseStrategy
    • BaseSupervisedLearningStrategy
    • TSCStrategy
    • TSRStrategy
    • BaseTask
    • TSCTask
    • TSRTask
    • PairwiseMetric
    • AggregateMetric
  • API Reference
  • Exceptions

Exceptions#

The sktime.exceptions module contains classes for exceptions and warnings.

Custom exceptions and warnings.

NotEvaluatedError

NotEvaluatedError.

NotFittedError

Exception class to raise if estimator is used before fitting.

FitFailedWarning

Warning class used if there is an error while fitting the estimator.

© Copyright 2019 - 2025 (BSD-3-Clause License).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.