diff --git a/docs/api/api.rst b/docs/api/api.rst index a025fb2f..818a4962 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -16,12 +16,18 @@ with the :ref:`tutorials`. datasets instance +.. toctree:: + :maxdepth: 1 + :caption: Interfaces + + learner + moa_learner + .. toctree:: :maxdepth: 1 :caption: Learners regressor - learners ssl classifiers @@ -30,3 +36,10 @@ with the :ref:`tutorials`. :caption: Evaluation evaluation + + +.. toctree:: + :maxdepth: 1 + :caption: Other + + splitcriteria diff --git a/docs/api/classifiers.rst b/docs/api/classifiers.rst index d58707eb..6df38147 100644 --- a/docs/api/classifiers.rst +++ b/docs/api/classifiers.rst @@ -1,9 +1,8 @@ Classifiers =========== -Classifiers implement the :class:`capymoa.learner.learners.Classifier` interface. +Classifiers implement the :class:`capymoa.Classifier` interface. -.. automodule:: capymoa.learner.classifier +.. automodule:: capymoa.classifier :members: :undoc-members: :show-inheritance: - :inherited-members: diff --git a/docs/api/datasets.rst b/docs/api/datasets.rst index b8efe4ec..6e213949 100644 --- a/docs/api/datasets.rst +++ b/docs/api/datasets.rst @@ -8,3 +8,9 @@ and used being downloaded the first time you use them. :undoc-members: :show-inheritance: :inherited-members: + +.. automodule:: capymoa.datasets.downloader + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/api/learners.rst b/docs/api/learner.rst similarity index 64% rename from docs/api/learners.rst rename to docs/api/learner.rst index 643dd941..2b53225a 100644 --- a/docs/api/learners.rst +++ b/docs/api/learner.rst @@ -3,17 +3,17 @@ Learners CapyMOA defines different interfaces for learners performing different machine learning tasks. -.. autoclass:: capymoa.learner.learners.Classifier +.. autoclass:: capymoa.Classifier :members: :undoc-members: :inherited-members: -.. autoclass:: capymoa.learner.learners.Regressor +.. autoclass:: capymoa.Regressor :members: :undoc-members: :inherited-members: -.. autoclass:: capymoa.learner.learners.ClassifierSSL +.. autoclass:: capymoa.ClassifierSSL :members: :undoc-members: :inherited-members: \ No newline at end of file diff --git a/docs/api/moa_learner.rst b/docs/api/moa_learner.rst new file mode 100644 index 00000000..e10e9965 --- /dev/null +++ b/docs/api/moa_learner.rst @@ -0,0 +1,14 @@ +MOA Learners +============ +Interfaces for objects that wrap MOA functionality. + +.. autoclass:: capymoa.base.MOAClassifier + :members: + :undoc-members: + :show-inheritance: + +.. autoclass:: capymoa.base.MOARegressor + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/regressor.rst b/docs/api/regressor.rst index 79a64286..4ac9e1df 100644 --- a/docs/api/regressor.rst +++ b/docs/api/regressor.rst @@ -1,10 +1,9 @@ Regressors ========== -Regressors implement the :class:`capymoa.learner.learners.Regressor` interface. +Regressors implement the :class:`capymoa.Regressor` interface. -.. automodule:: capymoa.learner.regressor +.. automodule:: capymoa.regressor :members: :undoc-members: :show-inheritance: - :inherited-members: diff --git a/docs/api/splitcriteria.rst b/docs/api/splitcriteria.rst new file mode 100644 index 00000000..9416fd37 --- /dev/null +++ b/docs/api/splitcriteria.rst @@ -0,0 +1,10 @@ +Split Criterions +================ +Decision trees are built by splitting the data into groups based on a split +criterion. The split criterion is a function that measures the quality of a +split. + +.. automodule:: capymoa.splitcriteria + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ssl.rst b/docs/api/ssl.rst index 752d76f6..7c5040cc 100644 --- a/docs/api/ssl.rst +++ b/docs/api/ssl.rst @@ -1,8 +1,8 @@ -Semi-Supervised Classifiers -=========================== -Semi-Supervised classifiers implement the :class:`capymoa.learner.learners.ClassifierSSL` interface. +Semi-Supervised Learners (SSL) +============================== +Semi-Supervised classifiers implement the :class:`capymoa.ClassifierSSL` interface. -.. automodule:: capymoa.learner.ssl.classifier +.. automodule:: capymoa.ssl.classifier :members: :undoc-members: :show-inheritance: