Add classifiers documentation

hyperdimensional-computing · Mar 11, 2024 · 81e7d08 · 81e7d08
1 parent 68621b4
commit 81e7d08
Show file tree

Hide file tree

Showing 6 changed files with 1,016 additions and 917 deletions.
diff --git a/docs/classifiers.rst b/docs/classifiers.rst
@@ -0,0 +1,22 @@
+.. _models:
+
+torchhd.classifiers
+=======================
+
+.. currentmodule:: torchhd.classifiers
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst
+
+    Classifier
+    Vanilla
+    AdaptHD
+    OnlineHD
+    RefineHD
+    NeuralHD
+    DistHD
+    LeHDC
+    CompHD
+    SparseHD
+    QuantHD
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ Torchhd is a Python library dedicated to *Hyperdimensional Computing* also known
    embeddings
    structures
    models
+   classifiers
    memory
    datasets
    utils

diff --git a/torchhd/__init__.py b/torchhd/__init__.py
@@ -25,7 +25,7 @@
 import torchhd.embeddings as embeddings
 import torchhd.structures as structures
 import torchhd.models as models
-import torchhd.classify as classify
+import torchhd.classifiers as classifiers
 import torchhd.memory as memory
 import torchhd.datasets as datasets
 import torchhd.utils as utils
@@ -93,7 +93,7 @@
     "embeddings",
     "structures",
     "models",
-    "classify",
+    "classifiers",
     "memory",
     "datasets",
     "utils",