Merge branch 'glm_class_restructure' of github.com:flatironinstitute/…

…generalized-linear-models into glm_class_restructure
flatironinstitute · Oct 30, 2023 · b363705 · b363705
2 parents 099d517 + 226a752
commit b363705
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/developers_notes/02-base_class.md b/docs/developers_notes/02-base_class.md
@@ -11,7 +11,7 @@ Designed to be compatible with the `scikit-learn` API, the class structure aims
 Below a scheme of how we envision the architecture of the `neurostatslib` models.
 
 ```
-Class _Base
+Abstract Class _Base
 │
 ├─ Abstract Subclass BaseRegressor
 │   │
@@ -41,7 +41,7 @@ Class _Base
 ```
 
 !!! Example
-    The current package version includes a concrete class named `neurostatslib.glm.GLM`. This class inherits from `BaseRegressor` <- `_Base`, since it falls under the " GLM regression" category. 
+    The current package version includes a concrete class named `neurostatslib.glm.GLM`. This class inherits from `BaseRegressor`, which in turn inherits `_Base`, since it falls under the " GLM regression" category. 
     As any `BaseRegressor`, it **must** implement the `fit`, `score`, `predict`, and `simulate` methods.
 
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,7 +12,7 @@ theme:
     - admonition
     - tables
 
-# if footnotes is degined in theme doesn't work
+# if footnotes is defined in theme doesn't work
 # If md_in_html is defined outside theme, it also results in
 # an error when building the docs.
 markdown_extensions: