Docs /Templates/ sinapsis-sktime

KNeighborsTimeSeriesClassifierPytsSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

KNeighborsTimeSeriesClassifierPyts — inherited documentation

K-nearest neighbors time series classifier, from ``pyts``.

Direct interface to ``pyts.classification.KNeighborsClassifier``, author of the interfaced class is ``johannfaouzi``.

Parameters ---------- n_neighbors : int, optional (default = 1) Number of neighbors to use.

weights : str or callable, optional (default = 'uniform') weight function used in prediction. Possible values:

- 'uniform' : uniform weights. All points in each neighborhood are weighted equally. - 'distance' : weight points by the inverse of their distance. in this case, closer neighbors of a query point will have a greater influence than neighbors which are further away. - [callable] : a user-defined function which accepts an array of distances, and returns an array of the same shape containing the weights.

algorithm : {'auto', 'ball_tree', 'kd_tree', 'brute'}, optional Algorithm used to compute the nearest neighbors. Ignored ff ``metric`` is either 'dtw', 'dtw_sakoechiba', 'dtw_itakura', 'dtw_multiscale', 'dtw_fast' or 'boss' ('brute' will be used).

Note: fitting on sparse input will override the setting of this parameter, using brute force.

leaf_size : int, optional (default = 30) Leaf size passed to BallTree or KDTree. This can affect the speed of the construction and query, as well as the memory required to store the tree. The optimal value depends on the nature of the problem.

metric : string or DistanceMetric object (default = 'minkowski') The distance metric to use for the tree. The default metric is minkowski, and with p=2 is equivalent to the standard Euclidean metric. See the documentation of the DistanceMetric class from scikit-learn for a list of available metrics. For Dynamic Time Warping, the available metrics are 'dtw', 'dtw_sakoechiba', 'dtw_itakura', 'dtw_multiscale' and 'dtw_fast'. For BOSS metric, one can use 'boss'.

p : integer, optional (default = 2) Power parameter for the Minkowski metric. When p = 1, this is equivalent to using manhattan_distance (l1), and euclidean_distance (l2) for p = 2. For arbitrary p, minkowski_distance (l_p) is used.

metric_params : dict, optional (default = None) Additional keyword arguments for the metric function.

n_jobs : int, optional (default = 1) The number of parallel jobs to run for neighbors search. If ``n_jobs=-1``, then the number of jobs is set to the number of CPU cores. Doesn't affect :meth:`fit` method.

Attributes ---------- classes_ : array, shape = (n_classes,) An array of class labels known to the classifier.

Examples -------- >>> from sktime.classification.distance_based import ( ... KNeighborsTimeSeriesClassifierPyts ... ) >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train") >>> X_test, y_test = load_unit_test(split="test") >>> clf = KNeighborsTimeSeriesClassifierPyts(n_neighbors=1, ... weights="uniform", ... algorithm="auto", ... leaf_size=30, ... p=2, ... metric="minkowski", ... metric_params=None, ... n_jobs=1, ... ) >>> clf.fit(X_train, y_train) KNeighborsTimeSeriesClassifierPyts(...) >>> 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. kneighborstimeseriesclassifierpyts_init n_neighbors <class 'int'>: default: 1 weights <class 'str'>: default: uniform algorithm typing.Union[str, typing.Any, NoneType]:… Read full field description

Path where the trained model will be saved. kneighborstimeseriesclassifierpyts_init n_neighbors <class 'int'>: default: 1 weights <class 'str'>: default: uniform algorithm typing.Union[str, typing.Any, NoneType]: default: auto leaf_size <class 'int'>: default: 30 p <class 'int'>: default: 2 metric <class 'str'>: default: minkowski metric_params typing.Optional[dict]: default: None n_jobs <class 'int'>: default: 1

str
Required
Default: null
kneighborstimeseriesclassifierpyts_initRequired
KNeighborsTimeSeriesClassifierPytsAttributes
Required
Default: null
p
int
Optional
Default: 2
metric
str
Optional
Default: "minkowski"
n_jobs
int
Optional
Default: 1
weights
str
Optional
Default: "uniform"
algorithm
typing.Union[str, typing.Any, NoneType]
Optional
Default: "auto"
leaf_size
int
Optional
Default: 30
n_neighbors
int
Optional
Default: 1
metric_params
typing.Optional[dict]
Optional
Default: null

Configuration example

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

yaml
templates:
  - template_name: "KNeighborsTimeSeriesClassifierPytsSKTimeWrapper"
    class_name: "KNeighborsTimeSeriesClassifierPytsSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      kneighborstimeseriesclassifierpyts_init:
        p: 2
        metric: "minkowski"
        n_jobs: 1
        weights: "uniform"
        algorithm: "auto"
        leaf_size: 30
        n_neighbors: 1
        metric_params: null

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDistanceClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere