Docs /Templates/ sinapsis-sktime

WEASELSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

WEASEL — inherited documentation

Word Extraction for Time Series Classification (WEASEL).

Overview: Input *n* series length *m* WEASEL is a dictionary classifier that builds a bag-of-patterns using SFA for different window lengths and learns a logistic regression classifier on this bag.

There are these primary parameters:

- alphabet_size: alphabet size - p-threshold: threshold used for chi^2-feature selection to select best words. - anova: select best l/2 fourier coefficients other than first ones - bigrams: using bigrams of SFA words - binning_strategy: the binning strategy used to discretise into SFA words.

WEASEL slides a window length *w* along the series. The *w* length window is shortened to an *l* length word through taking a Fourier transform and keeping the best *l/2* complex coefficients using an anova one-sided test. These *l* coefficients are then discretised into alpha possible symbols, to form a word of length *l*. A histogram of words for each series is formed and stored. For each window-length a bag is created and all words are joint into one bag-of-patterns. Words from different window-lengths are discriminated by different prefixes. *fit* involves training a logistic regression classifier on the single bag-of-patterns.

predict uses the logistic regression classifier

Parameters ---------- anova: boolean, default=True If True, the Fourier coefficient selection is done via a one-way ANOVA test. If False, the first Fourier coefficients are selected. Only applicable if labels are given bigrams: boolean, default=True whether to create bigrams of SFA words binning_strategy: {"equi-depth", "equi-width", "information-gain"}, default="information-gain" The binning method used to derive the breakpoints. window_inc: int, default=2 WEASEL create a BoP model for each window sizes. This is the increment used to determine the next window size. p_threshold: int, default=0.05 (disabled by default) Feature selection is applied based on the chi-squared test. This is the p-value threshold to use for chi-squared test on bag-of-words (lower means more strict). 1 indicates that the test should not be performed. alphabet_size : default = 2 Number of possible letters (values) for each word. feature_selection: {"chi2", "none", "random"}, default: chi2 Sets the feature selections strategy to be used. *Chi2* reduces the number of words significantly and is thus much faster (preferred). If set to chi2, p_threshold is applied. *Random* also reduces the number significantly. *None* applies not feature selectiona and yields large bag of words, e.g. much memory may be needed. support_probabilities: bool, default: False If set to False, a RidgeClassifierCV will be trained, which has higher accuracy and is faster, yet does not support predict_proba. If set to True, a LogisticRegression will be trained, which does support predict_proba(), yet is slower and typically less accuracy. predict_proba() is needed for example in Early-Classification like TEASER. random_state: int or None, default=None Seed for random, integer

Attributes ---------- n_classes_ : int The number of classes. classes_ : list The classes labels.

See Also -------- MUSE

References ---------- .. [1] Patrick Schäfer and Ulf Leser, "Fast and Accurate Time Series Classification with WEASEL", in proc ACM on Conference on Information and Knowledge Management, 2017, https://dl.acm.org/doi/10.1145/3132847.3132980

Notes ----- For the Java version, see - `Original Publication <https://github.com/patrickzib/SFA>`_. - `TSML <https://github.com/uea-machine-learning/tsml/blob/master/src/main/java /tsml/classifiers/dictionary_based/WEASEL.java>`_.

Examples -------- >>> from sktime.classification.dictionary_based import WEASEL >>> 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) # doctest: +SKIP >>> clf = WEASEL(window_inc=4) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP WEASEL(...) >>> y_pred = clf.predict(X_test) # 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"
weasel_initRequired
WEASELAttributes
Required
Default: null
anova
bool
Optional
Default: true
bigrams
bool
Optional
Default: true
window_inc
int
Optional
Default: 2
p_threshold
typing.Optional[int]
Optional
Default: 0.05
random_state
typing.Optional[int]
Optional
Default: null
alphabet_size
int
Optional
Default: 2
binning_strategy
typing.Union[str, typing.Any, NoneType]
Optional
Default: "information-gain"
feature_selection
typing.Union[str, typing.Any, NoneType]
Optional
Default: "chi2"
support_probabilities
bool
Optional
Default: false
model_save_pathRequired
Path where the trained model will be saved. weasel_init anova <class 'bool'>: default: True bigrams <class 'bool'>: default: True binning_strategy typing.Union[str, typing.Any, NoneType]: default: information-gain… Read full field description

Path where the trained model will be saved. weasel_init anova <class 'bool'>: default: True bigrams <class 'bool'>: default: True binning_strategy typing.Union[str, typing.Any, NoneType]: default: information-gain window_inc <class 'int'>: default: 2 p_threshold typing.Optional[int]: default: 0.05 alphabet_size <class 'int'>: default: 2 feature_selection typing.Union[str, typing.Any, NoneType]: default: chi2 support_probabilities <class 'bool'>: default: False random_state typing.Optional[int]: default: None

str
Required
Default: null

Configuration example

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

yaml
templates:
  - template_name: "WEASELSKTimeWrapper"
    class_name: "WEASELSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      weasel_init:
        anova: true
        bigrams: true
        window_inc: 2
        p_threshold: 0.05
        random_state: null
        alphabet_size: 2
        binning_strategy: "information-gain"
        feature_selection: "chi2"
        support_probabilities: false
      model_save_path: "<required>"

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDictionaryClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere