Docs /Templates/ sinapsis-sktime

CNTCClassifierSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

CNTCClassifier — inherited documentation

Contextual Time-series Neural Classifier (CNTC), as described in [1].

Adapted from the implementation from Fullah et. al https://github.com/AmaduFullah/CNTC_MODEL/blob/master/cntc.ipynb

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_attention : string, default = "sigmoid" Activation function inside the self attention module; List of available keras 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/ n_epochs : int, default = 2000 the number of epochs to train the model batch_size : int, default = 16 the number of samples per gradient update. filter_sizes : tuple of shape (2), default = (16, 8) filter sizes for CNNs in CCNN arm. kernel_sizes : two-tuple, default = (1, 1) the length of the 1D convolution window for CNNs in CCNN arm. rnn_size : int, default = 64 number of rnn units in the CCNN arm. lstm_size : int, default = 8 number of lstm units in the CLSTM arm. dense_size : int, default = 64 dimension of dense layer in CNTC. dropout : float or tuple of floats, default = (0.2, 0.2, 0.1, 0.1, 0.1, 0.1, 0.1) dropout rate(s), in the range [0, 1). If a single float is provided, the same dropout rate is applied to all layers. If a tuple is provided, it should have 7 values corresponding to: (conv1_dropout, rnn1_dropout, conv2_dropout, lstm_dropout, avg_dropout, att_dropout, mlp_dropout) where mlp_dropout is applied to both MLP layers. random_state : int or None, default=None Seed for random number generation. verbose : boolean, default = False whether to output extra information loss : string, default="mean_squared_error" fit parameter for the keras model optimizer : keras.optimizer, default=keras.optimizers.Adam(), metrics : list of strings, default=["accuracy"], callbacks : list of keras.callbacks, default = None,

References ---------- .. [1] Network originally defined in: @article{FULLAHKAMARA202057, title = {Combining contextual neural networks for time series classification}, journal = {Neurocomputing}, volume = {384}, pages = {57-66}, year = {2020}, issn = {0925-2312}, doi = {https://doi.org/10.1016/j.neucom.2019.10.113}, url = {https://www.sciencedirect.com/science/article/pii/S0925231219316364}, author = {Amadu {Fullah Kamara} and Enhong Chen and Qi Liu and Zhen Pan}, keywords = {Time series classification, Contextual convolutional neural networks, Contextual long short-term memory, Attention, Multilayer perceptron}, }

Examples -------- >>> from sktime.classification.deep_learning.cntc import CNTCClassifier >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train", return_X_y=True) >>> X_test, y_test = load_unit_test(split="test", return_X_y=True) >>> cntc = CNTCClassifier() # doctest: +SKIP >>> cntc.fit(X_train, y_train) # doctest: +SKIP CNTCClassifier(...) # doctest: +SKIP

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. cntcclassifier_init n_epochs <class 'int'>: default: 2000 batch_size <class 'int'>: default: 16 filter_sizes <class 'tuple'>: default: (16, 8) kernel_sizes <class 'tuple'>:… Read full field description

Path where the trained model will be saved. cntcclassifier_init n_epochs <class 'int'>: default: 2000 batch_size <class 'int'>: default: 16 filter_sizes <class 'tuple'>: default: (16, 8) kernel_sizes <class 'tuple'>: default: (1, 1) rnn_size <class 'int'>: default: 64 lstm_size <class 'int'>: default: 8 dense_size <class 'int'>: default: 64 dropout <class 'tuple'>: default: (0.2, 0.2, 0.1, 0.1, 0.1, 0.1, 0.1) callbacks <class 'NoneType'>: default: None verbose <class 'bool'>: default: False loss <class 'str'>: default: categorical_crossentropy metrics <class 'NoneType'>: default: None random_state <class 'int'>: default: 0 activation <class 'str'>: default: softmax activation_attention <class 'str'>: default: sigmoid activation_hidden <class 'str'>: default: relu

str
Required
Default: null
cntcclassifier_initRequired
CNTCClassifierAttributes
Required
Default: null
loss
str
Optional
Default: "categorical_crossentropy"
dropout
tuple
Optional
Default: [0.2,0.2,0.1,0.1,0.1,0.1,0.1]
metrics
NoneType
Optional
Default: null
verbose
bool
Optional
Default: false
n_epochs
int
Optional
Default: 2000
rnn_size
int
Optional
Default: 64
callbacks
NoneType
Optional
Default: null
lstm_size
int
Optional
Default: 8
activation
str
Optional
Default: "softmax"
batch_size
int
Optional
Default: 16
dense_size
int
Optional
Default: 64
filter_sizes
tuple
Optional
Default: [16,8]
kernel_sizes
tuple
Optional
Default: [1,1]
random_state
int
Optional
Default: 0
activation_hidden
str
Optional
Default: "relu"
activation_attention
str
Optional
Default: "sigmoid"

Configuration example

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

yaml
templates:
  - template_name: "CNTCClassifierSKTimeWrapper"
    class_name: "CNTCClassifierSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      cntcclassifier_init:
        loss: "categorical_crossentropy"
        dropout: {}
        metrics: null
        verbose: false
        n_epochs: 2000
        rnn_size: 64
        callbacks: null
        lstm_size: 8
        activation: "softmax"
        batch_size: 16
        dense_size: 64
        filter_sizes: {}
        kernel_sizes: {}
        random_state: 0
        activation_hidden: "relu"
        activation_attention: "sigmoid"

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDeepLearningClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere