Skip to main content

Oblique decision tree with svm nodes.

Project description

STree

CI CodeQL codecov Codacy Badge PyPI version https://img.shields.io/badge/python-3.11%2B-blue Ask DeepWiki DOI

Stree

Oblique Tree classifier based on SVM nodes. The nodes are built and splitted with sklearn SVC models. Stree is a sklearn estimator and can be integrated in pipelines, grid searches, etc.

Installation

pip install Stree

Documentation

Can be found in stree.readthedocs.io

Examples

Jupyter notebooks

  • benchmark Benchmark

  • features Some features

  • Gridsearch Gridsearch

  • Ensemble Ensembles

Hyperparameters

Hyperparameter Type/Values Default Meaning
* C <float> 1.0 Regularization parameter. The strength of the regularization is inversely proportional to C. Must be strictly positive.
* kernel {"liblinear", "linear", "poly", "rbf", "sigmoid"} linear Specifies the kernel type to be used in the algorithm. It must be one of ‘liblinear’, ‘linear’, ‘poly’ or ‘rbf’. liblinear uses liblinear library and the rest uses libsvm library through scikit-learn library
* max_iter <int> 1e5 Hard limit on iterations within solver, or -1 for no limit.
* random_state <int> None Controls the pseudo random number generation for shuffling the data for probability estimates. Ignored when probability is False.
Pass an int for reproducible output across multiple function calls
max_depth <int> None Specifies the maximum depth of the tree
* tol <float> 1e-4 Tolerance for stopping criterion.
* degree <int> 3 Degree of the polynomial kernel function (‘poly’). Ignored by all other kernels.
* gamma {"scale", "auto"} or <float> scale Kernel coefficient for ‘rbf’, ‘poly’ and ‘sigmoid’.
if gamma='scale' (default) is passed then it uses 1 / (n_features * X.var()) as value of gamma,
if ‘auto’, uses 1 / n_features.
split_criteria {"impurity", "max_samples"} impurity Decides (just in case of a multi class classification) which column (class) use to split the dataset in a node**. max_samples is incompatible with 'ovo' multiclass_strategy
criterion {“gini”, “entropy”} entropy The function to measure the quality of a split (only used if max_features != num_features).
Supported criteria are “gini” for the Gini impurity and “entropy” for the information gain.
min_samples_split <int> 0 The minimum number of samples required to split an internal node. 0 (default) for any
max_features <int>, <float>

or {“auto”, “sqrt”, “log2”}
None The number of features to consider when looking for the split:
If int, then consider max_features features at each split.
If float, then max_features is a fraction and int(max_features * n_features) features are considered at each split.
If “auto”, then max_features=sqrt(n_features).
If “sqrt”, then max_features=sqrt(n_features).
If “log2”, then max_features=log2(n_features).
If None, then max_features=n_features.
splitter {"best", "random", "trandom", "mutual", "cfs", "fcbf", "iwss"} "random" The strategy used to choose the feature set at each node (only used if max_features < num_features).
Supported strategies are: “best”: sklearn SelectKBest algorithm is used in every node to choose the max_features best features. “random”: The algorithm generates 5 candidates and choose the best (max. info. gain) of them. “trandom”: The algorithm generates only one random combination. "mutual": Chooses the best features w.r.t. their mutual info with the label. "cfs": Apply Correlation-based Feature Selection. "fcbf": Apply Fast Correlation-Based Filter. "iwss": IWSS based algorithm
normalize <bool> False If standardization of features should be applied on each node with the samples that reach it
* multiclass_strategy {"ovo", "ovr"} "ovo" Strategy to use with multiclass datasets, "ovo": one versus one. "ovr": one versus rest

* Hyperparameter used by the support vector classifier of every node

** Splitting in a STree node

The decision function is applied to the dataset and distances from samples to hyperplanes are computed in a matrix. This matrix has as many columns as classes the samples belongs to (if more than two, i.e. multiclass classification) or 1 column if it's a binary class dataset. In binary classification only one hyperplane is computed and therefore only one column is needed to store the distances of the samples to it. If three or more classes are present in the dataset we need as many hyperplanes as classes are there, and therefore one column per hyperplane is needed.

In case of multiclass classification we have to decide which column take into account to make the split, that depends on hyperparameter split_criteria, if "impurity" is chosen then STree computes information gain of every split candidate using each column and chooses the one that maximize the information gain, otherwise STree choses the column with more samples with a predicted class (the column with more positive numbers in it).

Once we have the column to take into account for the split, the algorithm splits samples with positive distances to hyperplane from the rest.

Tests

python -m unittest -v stree.tests

License

STree is MIT licensed

Reference

R. Montañana, J. A. Gámez, J. M. Puerta, "STree: a single multi-class oblique decision tree based on support vector machines.", 2021 LNAI 12882, pg. 54-64

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stree-1.4.1.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stree-1.4.1-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file stree-1.4.1.tar.gz.

File metadata

  • Download URL: stree-1.4.1.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for stree-1.4.1.tar.gz
Algorithm Hash digest
SHA256 f01d320354255ed5145aae77e9572d4b13445d267bf2b728aa90bc8ced3af324
MD5 6df6690dc862b400e687209fd06f1c47
BLAKE2b-256 741c6b70af944e56b5d9c65364206a9b1c01b4d129dc0d926d41561bd30381ee

See more details on using hashes here.

File details

Details for the file stree-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: stree-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for stree-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dacaf3dda6ccdd614db8819186f7b1ee7baccdbc5eec50e6806a1461b0b13500
MD5 982ca7e1f5bc7172d43a015924fed759
BLAKE2b-256 8f8e67e7b31f22d9b2319e38a83f3b28d57a83bdc6bb2733ff1c9a8c79970dd4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page