Docs /Templates/ sinapsis-sktime

FCNClassifierSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

FCNClassifier — inherited documentation

Fully Convolutional Network (FCN), as described in [1]_.

Adapted from the implementation from Fawaz et. al https://github.com/hfawaz/dl-4-tsc/blob/master/classifiers/fcn.py

Parameters ---------- 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. callbacks : list of keras.callbacks.Callback, optional (default=None) List of Keras callbacks to apply during model training. 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"], activation : string or a tf callable, default="sigmoid" 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/ use_bias : boolean, default = True whether the layer uses a bias vector. optimizer : keras.optimizers object, default = Adam(lr=0.01) specify the optimizer and the learning rate to be used. filter_sizes : list or tuple of int , default = (128,256,128) number of filters for each convolutional layer. must have length equal to kernel_sizes. kernel_sizes : list or tuple of int , default = (8,5,3) kernel size for each convolutional layer. must have length equal to filter_sizes.

References ---------- .. [1] Wang et al, Time series classification from scratch with deep neural networks: A strong baseline. 2017 International Joint Conference on Neural Networks (IJCNN)

Examples -------- >>> from sktime.classification.deep_learning.fcn import FCNClassifier >>> 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) >>> fcn = FCNClassifier(n_epochs=20,batch_size=4) # doctest: +SKIP >>> fcn.fit(X_train, y_train) # doctest: +SKIP FCNClassifier(...)

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. fcnclassifier_init n_epochs <class 'int'>: default: 2000 batch_size <class 'int'>: default: 16 callbacks <class 'NoneType'>: default: None verbose <class 'bool'>: default:… Read full field description

Path where the trained model will be saved. fcnclassifier_init n_epochs <class 'int'>: default: 2000 batch_size <class 'int'>: default: 16 callbacks <class 'NoneType'>: default: None verbose <class 'bool'>: default: False loss <class 'str'>: default: categorical_crossentropy metrics <class 'NoneType'>: default: None random_state typing.Optional[int]: default: None activation <class 'str'>: default: sigmoid activation_hidden <class 'str'>: default: relu use_bias <class 'bool'>: default: True optimizer <class 'NoneType'>: default: None filter_sizes <class 'tuple'>: default: (128, 256, 128) kernel_sizes <class 'tuple'>: default: (8, 5, 3)

str
Required
Default: null
fcnclassifier_initRequired
FCNClassifierAttributes
Required
Default: null
loss
str
Optional
Default: "categorical_crossentropy"
metrics
NoneType
Optional
Default: null
verbose
bool
Optional
Default: false
n_epochs
int
Optional
Default: 2000
use_bias
bool
Optional
Default: true
callbacks
NoneType
Optional
Default: null
optimizer
NoneType
Optional
Default: null
activation
str
Optional
Default: "sigmoid"
batch_size
int
Optional
Default: 16
filter_sizes
tuple
Optional
Default: [128,256,128]
kernel_sizes
tuple
Optional
Default: [8,5,3]
random_state
typing.Optional[int]
Optional
Default: null
activation_hidden
str
Optional
Default: "relu"

Configuration example

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

yaml
templates:
  - template_name: "FCNClassifierSKTimeWrapper"
    class_name: "FCNClassifierSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      fcnclassifier_init:
        loss: "categorical_crossentropy"
        metrics: null
        verbose: false
        n_epochs: 2000
        use_bias: true
        callbacks: null
        optimizer: null
        activation: "sigmoid"
        batch_size: 16
        filter_sizes: {}
        kernel_sizes: {}
        random_state: null
        activation_hidden: "relu"

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDeepLearningClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere