Docs /Templates/ sinapsis-sktime

ContractableBOSSSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

ContractableBOSS — inherited documentation

Contractable Bag of Symbolic Fourier Approximation Symbols (cBOSS).

Implementation of BOSS Ensemble from Schäfer (2015) with refinements described in Middlehurst, Vickers and Bagnall (2019). [1, 2]_

Overview: Input "n" series of length "m" and cBOSS randomly samples ``n_parameter_samples`` parameter sets, evaluating each with LOOCV. It then retains ``max_ensemble_size`` classifiers with the highest accuracy There are three primary parameters: - alpha: alphabet size - w: window length - l: word length.

For any combination, a single BOSS slides a window length "w" along the series. The "w" length window is shortened to an "l" length word by taking a Fourier transform and keeping the first l/2 complex coefficients. These "l" coefficients are then discretised into "alpha" possible values, to form a word length "l". A histogram of words for each series is formed and stored.

Fit involves finding "n" histograms.

Predict uses 1 nearest neighbor with a bespoke BOSS distance function.

Parameters ---------- n_parameter_samples : int, default = 250 If search is randomised, number of parameter combos to try. max_ensemble_size : int or None, default = 50 Maximum number of classifiers to retain. Will limit number of retained classifiers even if more than ``max_ensemble_size`` are within threshold. max_win_len_prop : int or float, default = 1 Maximum window length as a proportion of the series length. min_window : int, default = 10 Minimum window size. time_limit_in_minutes : int, default = 0 Time contract to limit build time in minutes. Default of 0 means no limit. contract_max_n_parameter_samples : int, default=np.inf Max number of parameter combinations to consider when time_limit_in_minutes is set. save_train_predictions : bool, default=False Save the ensemble member train predictions in fit for use in _get_train_probs leave-one-out cross-validation. n_jobs : int, default = 1 The number of jobs to run in parallel for both ``fit`` and ``predict``. ``-1`` means using all processors. feature_selection: {"chi2", "none", "random"}, default: none 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. random_state : int or None, default=None Seed for random integer.

Attributes ---------- n_classes_ : int Number of classes. Extracted from the data. classes_ : list The classes labels. n_instances_ : int Number of instances. Extracted from the data. n_estimators_ : int The final number of classifiers used. Will be <= ``max_ensemble_size`` if ``max_ensemble_size`` has been specified. series_length_ : int Length of all series (assumed equal). estimators_ : list List of DecisionTree classifiers. weights_ : Weight of each classifier in the ensemble.

See Also -------- BOSSEnsemble, IndividualBOSS

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

References ---------- .. [1] Patrick Schäfer, "The BOSS is concerned with time series classification in the presence of noise", Data Mining and Knowledge Discovery, 29(6): 2015 https://link.springer.com/article/10.1007/s10618-014-0377-7

.. [2] Matthew Middlehurst, William Vickers and Anthony Bagnall "Scalable Dictionary Classifiers for Time Series Classification", in proc 20th International Conference on Intelligent Data Engineering and Automated Learning,LNCS, volume 11871 https://link.springer.com/chapter/10.1007/978-3-030-33607-3_2

Examples -------- >>> from sktime.classification.dictionary_based import ContractableBOSS >>> 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) >>> clf = ContractableBOSS( ... n_parameter_samples=10, max_ensemble_size=3 ... ) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP ContractableBOSS(...) >>> 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"
model_save_pathRequired
Path where the trained model will be saved. contractableboss_init n_parameter_samples <class 'int'>: default: 250 max_ensemble_size <class 'int'>: default: 50 max_win_len_prop <class 'int'>: default: 1 min_window… Read full field description

Path where the trained model will be saved. contractableboss_init n_parameter_samples <class 'int'>: default: 250 max_ensemble_size <class 'int'>: default: 50 max_win_len_prop <class 'int'>: default: 1 min_window <class 'int'>: default: 10 time_limit_in_minutes typing.Optional[int]: default: 0.0 contract_max_n_parameter_samplestyping.Optional[int]: default: inf save_train_predictions <class 'bool'>: default: False feature_selection typing.Union[str, typing.Any, NoneType]: default: none n_jobs <class 'int'>: default: 1 random_state typing.Optional[int]: default: None

str
Required
Default: null
contractableboss_initRequired
ContractableBOSSAttributes
Required
Default: null
n_jobs
int
Optional
Default: 1
min_window
int
Optional
Default: 10
random_state
typing.Optional[int]
Optional
Default: null
max_win_len_prop
int
Optional
Default: 1
feature_selection
typing.Union[str, typing.Any, NoneType]
Optional
Default: "none"
max_ensemble_size
int
Optional
Default: 50
n_parameter_samples
int
Optional
Default: 250
time_limit_in_minutes
typing.Optional[int]
Optional
Default: 0
save_train_predictions
bool
Optional
Default: false
contract_max_n_parameter_samples
typing.Optional[int]
Optional
Default: null

Configuration example

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

yaml
templates:
  - template_name: "ContractableBOSSSKTimeWrapper"
    class_name: "ContractableBOSSSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      contractableboss_init:
        n_jobs: 1
        min_window: 10
        random_state: null
        max_win_len_prop: 1
        feature_selection: "none"
        max_ensemble_size: 50
        n_parameter_samples: 250
        time_limit_in_minutes: 0
        save_train_predictions: false
        contract_max_n_parameter_samples: null

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDictionaryClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere