Docs /Templates/ sinapsis-sktime

MUSESKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

MUSE — inherited documentation

MUSE (MUltivariate Symbolic Extension).

Also known as WEASLE-MUSE: implementation of multivariate version of WEASEL, referred to as just MUSE from [1].

WEASEL+MUSE is a multivariate 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 * ``chi2-threshold``: used for 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 discretize into SFA words.

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 ``variance``: boolean, default = False Whether to use the variance-based selection for Fourier coefficients.

* If True, the Fourier coefficient selection is done via the largest variance. * 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 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. alphabet_size : default = 4 Number of possible letters (values) for each word. p_threshold: int, default=0.05 (disabled by default) Used when 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. use_first_order_differences: boolean, default=True If set to True will add the first order differences of each dimension to the data. 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. 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). Random also reduces the number significantly. None applies not feature selectiona and yields large bag of words, e.g. much memory may be needed. n_jobs : int, default=1 The number of jobs to run in parallel for both ``fit`` and ``predict``. ``-1`` means using all processors. 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 -------- WEASEL

References ---------- .. [1] Patrick Schäfer and Ulf Leser, "Multivariate time series classification with WEASEL+MUSE", in proc 3rd ECML/PKDD Workshop on AALTD}, 2018 https://arxiv.org/abs/1711.11343

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

Examples -------- >>> from sktime.classification.dictionary_based import MUSE >>> 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 = MUSE(window_inc=4, use_first_order_differences=False) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP MUSE(...) >>> 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"
muse_initRequired
MUSEAttributes
Required
Default: null
anova
bool
Optional
Default: true
n_jobs
int
Optional
Default: 1
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: 4
feature_selection
typing.Union[str, typing.Any, NoneType]
Optional
Default: "chi2"
support_probabilities
bool
Optional
Default: false
use_first_order_differences
bool
Optional
Default: true
model_save_pathRequired
Path where the trained model will be saved. muse_init anova <class 'bool'>: default: True bigrams <class 'bool'>: default: True window_inc <class 'int'>: default: 2 alphabet_size <class 'int'>: default: 4… Read full field description

Path where the trained model will be saved. muse_init anova <class 'bool'>: default: True bigrams <class 'bool'>: default: True window_inc <class 'int'>: default: 2 alphabet_size <class 'int'>: default: 4 use_first_order_differences <class 'bool'>: default: True feature_selection typing.Union[str, typing.Any, NoneType]: default: chi2 p_threshold typing.Optional[int]: default: 0.05 support_probabilities <class 'bool'>: default: False n_jobs <class 'int'>: default: 1 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: "MUSESKTimeWrapper"
    class_name: "MUSESKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      muse_init:
        anova: true
        n_jobs: 1
        bigrams: true
        window_inc: 2
        p_threshold: 0.05
        random_state: null
        alphabet_size: 4
        feature_selection: "chi2"
        support_probabilities: false
        use_first_order_differences: true
      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