Docs /Templates/ sinapsis-sktime

SummaryClassifierSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

SummaryClassifier — inherited documentation

Summary statistic classifier.

This classifier simply transforms the input data using the SummaryTransformer transformer and builds a provided estimator using the transformed data.

Parameters ---------- summary_functions : str, list, tuple, default=("mean", "std", "min", "max") Either a string, or list or tuple of strings indicating the pandas summary functions that are used to summarize each column of the dataset. Must be one of ("mean", "min", "max", "median", "sum", "skew", "kurt", "var", "std", "mad", "sem", "nunique", "count"). summary_quantiles : str, list, tuple or None, default=(0.25, 0.5, 0.75) Optional list of series quantiles to calculate. If None, no quantiles are calculated. estimator : sklearn classifier, default=None An sklearn estimator to be built using the transformed data. Defaults to a Random Forest with 200 trees. 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 Number of classes. Extracted from the data. classes_ : ndarray of shape (n_classes) Holds the label for each class.

See Also -------- SummaryTransformer

Examples -------- >>> from sktime.classification.feature_based import SummaryClassifier >>> from sklearn.ensemble import RandomForestClassifier >>> 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 = SummaryClassifier(estimator=RandomForestClassifier(n_estimators=5)) >>> clf.fit(X_train, y_train) SummaryClassifier(...) >>> y_pred = clf.predict(X_test)

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. summaryclassifier_init summary_functions typing.Optional[str]: default: ('mean', 'std', 'min', 'max') summary_quantiles typing.Optional[str]: default: (0.25, 0.5, 0.75)… Read full field description

Path where the trained model will be saved. summaryclassifier_init summary_functions typing.Optional[str]: default: ('mean', 'std', 'min', 'max') summary_quantiles typing.Optional[str]: default: (0.25, 0.5, 0.75) estimator <class 'NoneType'>: default: None n_jobs <class 'int'>: default: 1 random_state typing.Optional[int]: default: None

str
Required
Default: null
summaryclassifier_initRequired
SummaryClassifierAttributes
Required
Default: null
n_jobs
int
Optional
Default: 1
estimator
NoneType
Optional
Default: null
random_state
typing.Optional[int]
Optional
Default: null
summary_functions
typing.Optional[str]
Optional
Default: ["mean","std","min","max"]
summary_quantiles
typing.Optional[str]
Optional
Default: [0.25,0.5,0.75]

Configuration example

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

yaml
templates:
  - template_name: "SummaryClassifierSKTimeWrapper"
    class_name: "SummaryClassifierSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      summaryclassifier_init:
        n_jobs: 1
        estimator: null
        random_state: null
        summary_functions: ["mean", "std", "min", "max"]
        summary_quantiles: [0.25, 0.5, 0.75]

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeFeatureClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere