Docs /Templates/ sinapsis-sktime

ProximityTreeSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

ProximityTree — inherited documentation

Proximity Tree class.

A decision tree which uses distance measures to partition data.

Parameters ---------- random_state: int or np.RandomState, default=0 random seed for the random number generator distance_measure: ``None`` (default) or str; if str, one of ``euclidean``, ``dtw``, ``ddtw``, ``wdtw``, ``wddtw``, ``msm``, ``lcss``, ``erp`` distance measure to use if ``None``, selects distances randomly from the list of available distances max_depth: int or math.inf, default=math.inf maximum depth of the tree is_leaf : function, default=pure decide when to mark a node as a leaf node verbosity: 0 or 1 number reflecting the verbosity of logging 0 = no logging, 1 = verbose logging n_jobs: int or None, default=1 number of parallel threads to use while building n_stump_evaluations: number of stump evaluations to do if find_stump method is None

Examples -------- >>> from sktime.classification.distance_based import ProximityTree >>> 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 = ProximityTree(max_depth=2, n_stump_evaluations=1) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP ProximityTree(...) >>> 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. proximitytree_init random_state typing.Optional[int]: default: None distance_measure <class 'NoneType'>: default: None max_depth typing.Optional[int]: default: inf is_leaf… Read full field description

Path where the trained model will be saved. proximitytree_init random_state typing.Optional[int]: default: None distance_measure <class 'NoneType'>: default: None max_depth typing.Optional[int]: default: inf is_leaf <class 'function'>: default: <function pure at 0x7de5785bb420> verbosity typing.Optional[1]: default: 0 n_jobs <class 'int'>: default: 1 n_stump_evaluations <class 'int'>: default: 5

str
Required
Default: null
proximitytree_initRequired
ProximityTreeAttributes
Required
Default: null
n_jobs
int
Optional
Default: 1
is_leaf
function
Optional
Default: null
max_depth
typing.Optional[int]
Optional
Default: null
verbosity
typing.Optional[1]
Optional
Default: 0
random_state
typing.Optional[int]
Optional
Default: null
distance_measure
NoneType
Optional
Default: null
n_stump_evaluations
int
Optional
Default: 5

Configuration example

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

yaml
templates:
  - template_name: "ProximityTreeSKTimeWrapper"
    class_name: "ProximityTreeSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      proximitytree_init:
        n_jobs: 1
        is_leaf: {}
        max_depth: null
        verbosity: 0
        random_state: null
        distance_measure: null
        n_stump_evaluations: 5

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_classifiers.SKTimeDistanceClassifiers

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere