MNT refactor narx module (#125)

Author: MatthewSZhang

doc/conf.py

@@ -10,8 +10,6 @@
 import importlib.metadata
 from datetime import datetime
 
-# project root
-# sys.path.insert(0, os.path.abspath(".."))
 # General information about the project.
 project = "fastcan"
 copyright = f"2024 - {datetime.now().year}, fastcan developers (MIT License)"
@@ -59,6 +57,7 @@
 
 # generate autosummary even if no references
 autosummary_generate = True
+autosummary_ignore_module_all = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"

doc/index.rst

@@ -17,30 +17,13 @@ Architecture Diagram
 
 API Reference
 -------------
-.. automodule:: fastcan
+.. autosummary::
+   :toctree: generated/
+   :template: module.rst
 
-   .. rubric:: Classes
-
-   .. autosummary::
-      :toctree: generated/
-
-         FastCan
-   
-   .. rubric:: Functions
-
-   .. autosummary::
-      :toctree: generated/
-
-         refine
-         minibatch
-   
-   .. rubric:: Submodules
-
-   .. autosummary::
-      :toctree: generated/
-
-         narx
-         utils
+   fastcan
+   fastcan.narx
+   fastcan.utils
 
 Useful Links
 ------------

doc/templates/autosummary/class.rst renamed to doc/templates/class.rst

@@ -8,6 +8,7 @@
 
     .. autosummary::
         :toctree:
+        :template: class.rst
     {% for item in classes %}
         {{ item }}
     {%- endfor %}
@@ -21,6 +22,7 @@
 
     .. autosummary::
         :toctree:
+        :template: function.rst
     {% for item in functions %}
         {{ item }}
     {%- endfor %}

doc/templates/autosummary/function.rst renamed to doc/templates/function.rst

@@ -1,6 +1,5 @@
 """
-The implementation of fast canonical correlation analysis based feature selection
-algorithm.
+Fast canonical correlation analysis based greedy search algorithm.
 """
 
 # Authors: The fastcan developers

doc/templates/autosummary/module.rst renamed to doc/templates/module.rst

@@ -1,5 +1,5 @@
 """
-Fast feature selection with sum squared canonical correlation coefficients
+Fast forward greedy search with sum squared canonical correlation coefficients.
 """
 # Authors: The fastcan developers
 # SPDX-License-Identifier: MIT

fastcan/__init__.py

@@ -1,5 +1,5 @@
 """
-Feature selection
+Fast canonical correlation analysis based selector.
 """
 
 # Authors: The fastcan developers

fastcan/_cancorr_fast.pyx

@@ -1,5 +1,5 @@
 """
-Feature selection with mini-batch.
+Mini-batch selection.
 """
 
 # Authors: The fastcan developers

fastcan/_fastcan.py

@@ -1,5 +1,5 @@
 """
-Refine fastcan selection results
+Refine fastcan selection results.
 """
 
 # Authors: The fastcan developers