Docs /Templates/ sinapsis-sktime

InceptionTimeClassifierSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

Template for SkTime classification model training and inference for the deep_learning module.

InceptionTimeClassifier — inherited documentation

InceptionTime Deep Learning Classifier.

Adapted from the implementation from Fawaz et. al https://github.com/hfawaz/InceptionTime/blob/master/classifiers/inception.py

Described in [1]_, InceptionTime is a deep learning model designed for time series classification. It is based on the Inception architecture for images. The model is made up of a series of Inception modules.

``InceptionTimeClassifier`` is a single instance of InceptionTime model described in the original publication [1]_, which uses an ensemble of 5 single instances.

To build an ensemble of models mirroring [1]_, use the ``BaggingClassifier`` with ``n_estimators=5``, ``bootstrap=False``, and ``estimator`` being an instance of this ``InceptionTimeClassifier``.

Parameters ---------- activation : string or a tf callable, default="softmax" Activation function used in the output layer. List of available activation functions: https://keras.io/api/layers/activations/ activation_hidden : string or a tf callable, default="relu" Activation function used in the hidden layers. List of available activation functions: https://keras.io/api/layers/activations/ activation_inception : string or a tf callable, default="linear" Activation function used in the Inception modules. List of available activation functions: https://keras.io/api/layers/activations/ n_epochs : int, default=1500 batch_size : int, default=64 the number of samples per gradient update kernel_size : int, default=40 specifying the length of the 1D convolution window n_filters : int, default=32 use_residual : boolean, default=True use_bottleneck : boolean, default=True bottleneck_size : int, default=32 depth : int, default=6 callbacks : list of tf.keras.callbacks.Callback objects random_state: int, optional, default=None random seed for internal random number generator verbose: boolean, default=False whether to print runtime information loss: str, default="categorical_crossentropy" metrics: optional class_weight: dict, optional, default=None Dictionary mapping class labels to a weight (float) value to be used during model training. For example, ``{"A": 1.0, "B": 2.5}`` will assign a weight of 1.0 to class "A" and 2.5 to class "B". This is passed directly to Keras' ``fit`` method as the ``class_weight`` argument after converting labels to integer encoding. If None, all classes are given equal weight.

Notes ----- ..[1] Fawaz et. al, InceptionTime: Finding AlexNet for Time Series Classification, Data Mining and Knowledge Discovery, 34, 2020

Examples -------- Single instance of InceptionTime model: >>> from sktime.classification.deep_learning import InceptionTimeClassifier >>> from sktime.datasets import load_unit_test # doctest: +SKIP >>> X_train, y_train = load_unit_test(split="train") # doctest: +SKIP >>> X_test, y_test = load_unit_test(split="test") # doctest: +SKIP >>> clf = InceptionTimeClassifier() # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP InceptionTimeClassifier(...)

To build an ensemble of models mirroring [1]_, use the ``BaggingClassifier`` as follows: >>> from sktime.classification.ensemble import BaggingClassifier >>> from sktime.classification.deep_learning import InceptionTimeClassifier >>> from sktime.datasets import load_unit_test # doctest: +SKIP >>> X_train, y_train = load_unit_test(split="train") # doctest: +SKIP >>> X_test, y_test = load_unit_test(split="test") # doctest: +SKIP >>> clf = BaggingClassifier( ... InceptionTimeClassifier(), ... n_estimators=5, ... bootstrap=False ... ) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP BaggingClassifier(...)

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-sktime==1.0.0
uv pip install sinapsis-sktime==1.0.0
uv add sinapsis-sktime==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
root_dir
str
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
model_save_pathRequired
Path where the trained model will be saved. inceptiontimeclassifier_init n_epochs <class 'int'>: default: 1500 batch_size <class 'int'>: default: 64 kernel_size <class 'int'>: default: 40 n_filters <class 'int'>:… Read full field description

Path where the trained model will be saved. inceptiontimeclassifier_init n_epochs <class 'int'>: default: 1500 batch_size <class 'int'>: default: 64 kernel_size <class 'int'>: default: 40 n_filters <class 'int'>: default: 32 use_residual <class 'bool'>: default: True use_bottleneck <class 'bool'>: default: True bottleneck_size <class 'int'>: default: 32 depth <class 'int'>: default: 6 callbacks <class 'NoneType'>: default: None random_state typing.Optional[int]: default: None verbose <class 'bool'>: default: False loss <class 'str'>: default: categorical_crossentropy metrics <class 'NoneType'>: default: None class_weight typing.Optional[dict]: default: None activation <class 'str'>: default: softmax activation_hidden <class 'str'>: default: relu activation_inception <class 'str'>: default: linear

str
Required
Default: null
inceptiontimeclassifier_initRequired
InceptionTimeClassifierAttributes
Required
Default: null
loss
str
Optional
Default: "categorical_crossentropy"
depth
int
Optional
Default: 6
metrics
NoneType
Optional
Default: null
verbose
bool
Optional
Default: false
n_epochs
int
Optional
Default: 1500
callbacks
NoneType
Optional
Default: null
n_filters
int
Optional
Default: 32
activation
str
Optional
Default: "softmax"
batch_size
int
Optional
Default: 64
kernel_size
int
Optional
Default: 40
class_weight
typing.Optional[dict]
Optional
Default: null
random_state
typing.Optional[int]
Optional
Default: null
use_residual
bool
Optional
Default: true
use_bottleneck
bool
Optional
Default: true
bottleneck_size
int
Optional
Default: 32
activation_hidden
str
Optional
Default: "relu"
activation_inception
str
Optional
Default: "linear"

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "InceptionTimeClassifierSKTimeWrapper"
    class_name: "InceptionTimeClassifierSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      inceptiontimeclassifier_init:
        loss: "categorical_crossentropy"
        depth: 6
        metrics: null
        verbose: false
        n_epochs: 1500
        callbacks: null
        n_filters: 32
        activation: "softmax"
        batch_size: 64
        kernel_size: 40
        class_weight: null
        random_state: null
        use_residual: true
        use_bottleneck: true
        bottleneck_size: 32
        activation_hidden: "relu"
        activation_inception: "linear"

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDeepLearningClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere