From ecc28007059709f8b588f04b7c46c09fc53a8ef8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Montan=CC=83ana?= Date: Wed, 21 Jul 2021 11:24:37 +0200 Subject: [PATCH] Fix mistakes in README and in docs --- README.md | 4 ++-- docs/source/hyperparameters.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aec97e8..35ea097 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ pip install git+https://github.com/doctorado-ml/stree ## Documentation -Can be found in +Can be found in [stree.readthedocs.io](https://stree.readthedocs.io/en/stable/) ## Examples @@ -44,7 +44,7 @@ Can be found in | | max_depth | \ | None | Specifies the maximum depth of the tree | | \* | tol | \ | 1e-4 | Tolerance for stopping criterion. | | \* | degree | \ | 3 | Degree of the polynomial kernel function (‘poly’). Ignored by all other kernels. | -| \* | gamma | {"scale", "auto"} or \ | scale | Kernel coefficient for ‘rbf’ and ‘poly’.
if gamma='scale' (default) is passed then it uses 1 / (n_features \* X.var()) as value of gamma,
if ‘auto’, uses 1 / n_features. | +| \* | gamma | {"scale", "auto"} or \ | 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 | \ | 0 | The minimum number of samples required to split an internal node. 0 (default) for any | diff --git a/docs/source/hyperparameters.md b/docs/source/hyperparameters.md index 3109a1a..4c5c923 100644 --- a/docs/source/hyperparameters.md +++ b/docs/source/hyperparameters.md @@ -9,7 +9,7 @@ | | max_depth | \ | None | Specifies the maximum depth of the tree | | \* | tol | \ | 1e-4 | Tolerance for stopping criterion. | | \* | degree | \ | 3 | Degree of the polynomial kernel function (‘poly’). Ignored by all other kernels. | -| \* | gamma | {"scale", "auto"} or \ | scale | Kernel coefficient for ‘rbf’ and ‘poly’.
if gamma='scale' (default) is passed then it uses 1 / (n_features \* X.var()) as value of gamma,
if ‘auto’, uses 1 / n_features. | +| \* | gamma | {"scale", "auto"} or \ | 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 | \ | 0 | The minimum number of samples required to split an internal node. 0 (default) for any |