Docs /Templates/ sinapsis-sktime

ProximityForestSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_classifiers

Overview

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

ProximityForest — inherited documentation

Proximity Forest classifier.

Forest of decision tree which uses distance measures to partition data [1]. Uses ProximityTree internally.

Parameters ---------- random_state: int or np.RandomState, default=None random seed for the random number generator n_estimators: int, default=100 The number of trees in the forest. 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 verbosity: 0 or 1 number reflecting the verbosity of logging 0 = no logging, 1 = verbose logging max_depth: int or math.inf, default=math.inf maximum depth of the tree is_leaf: function, default=pure function to decide when to mark a node as a leaf node n_jobs: int, default=1 number of jobs to run in parallel *across threads" n_stump_evaluations: int, default=5 number of stump evaluations to do if find_stump method is None

References ---------- .. [1] Ben Lucas et al., "Proximity Forest: an effective and scalable distance-based classifier for time series",vData Mining and Knowledge Discovery, 33(3): 607-635, 2019 https://arxiv.org/abs/1808.10594 Java wrapper of authors original https://github.com/uea-machine-learning/tsml/blob/master/src/main/java/tsml/ classifiers/distance_based/ProximityForestWrapper.java Java version https://github.com/uea-machine-learning/tsml/blob/master/src/main/java/tsml/ classifiers/distance_based/proximity/ProximityForest.java

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

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

str
Required
Default: null
proximityforest_initRequired
ProximityForestAttributes
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
n_estimators
int
Optional
Default: 100
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: "ProximityForestSKTimeWrapper"
    class_name: "ProximityForestSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      model_save_path: "<required>"
      proximityforest_init:
        n_jobs: 1
        is_leaf: {}
        max_depth: null
        verbosity: 0
        n_estimators: 100
        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