Docs /Templates/ sinapsis-sktime

SimpleRNNClassifierSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

SimpleRNNClassifier — inherited documentation

Simple recurrent neural network.

For a drop-in replacement based on PyTorch, see `SimpleRNNClassifierTorch`.

Parameters ---------- n_epochs : int, default = 100 the number of epochs to train the model batch_size : int, default = 1 the number of samples per gradient update. units : int, default = 6 number of units in the network callbacks : tuple of tf.keras.callbacks.Callback objects, default = None add_default_callback : bool, default = True whether to add default callback random_state : int or None, default=0 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 metrics : list of strings, default=["accuracy"] metrics to use in fitting the neural network 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="tanh" 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 = RMSprop(lr=0.001) specify the optimizer and the learning rate to be used. dropout : float, default=0.0 The dropout rate for the RNN layer.

References ---------- ..[1] benchmark forecaster in M4 forecasting competition: https://github.com/Mcompetitions/M4-methods

Examples -------- >>> from sktime.classification.deep_learning.rnn import SimpleRNNClassifier >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train") >>> clf = SimpleRNNClassifier(n_epochs=20,batch_size=20) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP ResNetClassifier(...)

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. simplernnclassifier_init n_epochs <class 'int'>: default: 100 batch_size <class 'int'>: default: 1 units <class 'int'>: default: 6 callbacks <class 'NoneType'>: default: None… Read full field description

Path where the trained model will be saved. simplernnclassifier_init n_epochs <class 'int'>: default: 100 batch_size <class 'int'>: default: 1 units <class 'int'>: default: 6 callbacks <class 'NoneType'>: default: None add_default_callback <class 'bool'>: default: True random_state <class 'int'>: default: 0 verbose <class 'bool'>: default: False loss <class 'str'>: default: mean_squared_error metrics <class 'NoneType'>: default: None activation <class 'str'>: default: sigmoid activation_hidden <class 'str'>: default: tanh use_bias <class 'bool'>: default: True optimizer <class 'NoneType'>: default: None dropout <class 'float'>: default: 0.0

str
Required
Default: null
simplernnclassifier_initRequired
SimpleRNNClassifierAttributes
Required
Default: null
loss
str
Optional
Default: "mean_squared_error"
units
int
Optional
Default: 6
dropout
float
Optional
Default: 0
metrics
NoneType
Optional
Default: null
verbose
bool
Optional
Default: false
n_epochs
int
Optional
Default: 100
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: 1
random_state
int
Optional
Default: 0
activation_hidden
str
Optional
Default: "tanh"
add_default_callback
bool
Optional
Default: true

Configuration example

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

yaml
templates:
  - template_name: "SimpleRNNClassifierSKTimeWrapper"
    class_name: "SimpleRNNClassifierSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      simplernnclassifier_init:
        loss: "mean_squared_error"
        units: 6
        dropout: 0
        metrics: null
        verbose: false
        n_epochs: 100
        use_bias: true
        callbacks: null
        optimizer: null
        activation: "sigmoid"
        batch_size: 1
        random_state: 0
        activation_hidden: "tanh"
        add_default_callback: true

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDeepLearningClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere