Update documentation

adaptive-machine-learning · Apr 16, 2024 · 576c907 · 576c907
1 parent 6c35df9
commit 576c907
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 14 deletions.
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -16,12 +16,18 @@ with the :ref:`tutorials<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<tutorials>`.
     :caption: Evaluation
 
     evaluation
+
+
+..  toctree::
+    :maxdepth: 1
+    :caption: Other
+
+    splitcriteria
diff --git 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
@@ -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:
diff --git a/docs/api/learners.rst → docs/api/learner.rst b/docs/api/learners.rst → 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:
diff --git a/docs/api/moa_learner.rst 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
@@ -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
@@ -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:
diff --git 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: