From 9eb06a916990af95782ea5a55cc66c4dea571ce9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Montan=CC=83ana?= Date: Mon, 19 Apr 2021 01:09:13 +0200 Subject: [PATCH] Update doc to separate classes in api --- README.md | 1 + docs/source/api/Siterator.rst | 9 +++++++++ docs/source/api/Snode.rst | 9 +++++++++ docs/source/api/Splitter.rst | 9 +++++++++ docs/source/api/Stree.rst | 9 +++++++++ docs/source/api/index.rst | 11 +++++++++++ docs/source/hyperparameters.md | 1 + docs/source/index.rst | 13 +++++-------- docs/source/install.rst | 2 +- docs/source/package.rst | 8 -------- 10 files changed, 55 insertions(+), 17 deletions(-) create mode 100644 docs/source/api/Siterator.rst create mode 100644 docs/source/api/Snode.rst create mode 100644 docs/source/api/Splitter.rst create mode 100644 docs/source/api/Stree.rst create mode 100644 docs/source/api/index.rst delete mode 100644 docs/source/package.rst diff --git a/README.md b/README.md index c5e0413..e13bcc9 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ Can be found in | | min_samples_split | \ | 0 | The minimum number of samples required to split an internal node. 0 (default) for any | | | max_features | \, \

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"} | random | The strategy used to choose the feature set at each node (only used if max_features != num_features).
Supported strategies are “best” to choose the best feature set and “random” to choose a random combination.
The algorithm generates 5 candidates at most to choose from in both strategies. | +| | normalize | \ | False | If standardization of features should be applied on each node with the samples that reach it | \* Hyperparameter used by the support vector classifier of every node diff --git a/docs/source/api/Siterator.rst b/docs/source/api/Siterator.rst new file mode 100644 index 0000000..74cabcc --- /dev/null +++ b/docs/source/api/Siterator.rst @@ -0,0 +1,9 @@ +Siterator +========= + +.. automodule:: stree +.. autoclass:: Siterator + :members: + :undoc-members: + :private-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/api/Snode.rst b/docs/source/api/Snode.rst new file mode 100644 index 0000000..8234371 --- /dev/null +++ b/docs/source/api/Snode.rst @@ -0,0 +1,9 @@ +Snode +===== + +.. automodule:: stree +.. autoclass:: Snode + :members: + :undoc-members: + :private-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/api/Splitter.rst b/docs/source/api/Splitter.rst new file mode 100644 index 0000000..e69921e --- /dev/null +++ b/docs/source/api/Splitter.rst @@ -0,0 +1,9 @@ +Splitter +======== + +.. automodule:: stree +.. autoclass:: Splitter + :members: + :undoc-members: + :private-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/api/Stree.rst b/docs/source/api/Stree.rst new file mode 100644 index 0000000..1f0de94 --- /dev/null +++ b/docs/source/api/Stree.rst @@ -0,0 +1,9 @@ +Stree +===== + +.. automodule:: stree +.. autoclass:: Stree + :members: + :undoc-members: + :private-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst new file mode 100644 index 0000000..e7f78cc --- /dev/null +++ b/docs/source/api/index.rst @@ -0,0 +1,11 @@ +API index +========= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + Stree + Splitter + Snode + Siterator diff --git a/docs/source/hyperparameters.md b/docs/source/hyperparameters.md index c99c965..a4fa6f7 100644 --- a/docs/source/hyperparameters.md +++ b/docs/source/hyperparameters.md @@ -15,6 +15,7 @@ | | min_samples_split | \ | 0 | The minimum number of samples required to split an internal node. 0 (default) for any | | | max_features | \, \

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"} | random | The strategy used to choose the feature set at each node (only used if max_features != num_features).
Supported strategies are “best” to choose the best feature set and “random” to choose a random combination.
The algorithm generates 5 candidates at most to choose from in both strategies. | +| | normalize | \ | False | If standardization of features should be applied on each node with the samples that reach it | \* Hyperparameter used by the support vector classifier of every node diff --git a/docs/source/index.rst b/docs/source/index.rst index fba24f6..ccfdd26 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,18 +1,15 @@ -.. STree documentation master file, created by - sphinx-quickstart on Sun Apr 18 12:24:32 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to STree's documentation! ================================= .. toctree:: - :maxdepth: 2 :caption: Contents: + :titlesonly: + stree install hyperparameters example - package -* :ref:`genindex` + api/index + +* :ref:`genindex` \ No newline at end of file diff --git a/docs/source/install.rst b/docs/source/install.rst index fd35047..d83e55d 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -3,7 +3,7 @@ Install The main stable release -``pip install stree``` +``pip install stree`` or the last development branch diff --git a/docs/source/package.rst b/docs/source/package.rst deleted file mode 100644 index 169ffa4..0000000 --- a/docs/source/package.rst +++ /dev/null @@ -1,8 +0,0 @@ -STree package -============= - -.. automodule:: stree - :members: Stree, Snode, Splitter, Siterator - :undoc-members: - :private-members: - :show-inheritance: