Modify documentation structure

Author: lopezco

docsrc/source/base_model.rst

@@ -0,0 +1,7 @@
+Base Model
+~~~~~~~~~~
+.. automodule:: python.model.base
+  :members:
+  :undoc-members:
+  :show-inheritance:
+  :exclude-members: SHAP_AVAILABLE, Task

docsrc/source/code_doc.rst

@@ -0,0 +1,10 @@
+Code Documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   base_model
+   sklearn_model
+   service_api

docsrc/source/index.rst

@@ -3,32 +3,5 @@
    :maxdepth: 3
    :caption: Contents:
 
-.. mdinclude:: ../../README.md
-
-
-Code Documentation
-==================
-
-Model Class
------------
-.. automodule:: model
-  :members:
-  :undoc-members:
-  :show-inheritance:
-  :exclude-members: SHAP_AVAILABLE, Task
-
-
-Service
--------
-.. automodule:: service
-  :members:
-  :undoc-members:
-  :show-inheritance:
-  :exclude-members: DEBUG, MODEL_NAME, ENVIRONMENT, SERVICE_START_TIMESTAMP, app, model, NumpyEncoder, returns_json, create_model_instance
-
-
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   readme
+   code_doc

docsrc/source/readme.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../README.md

docsrc/source/service_api.rst

@@ -0,0 +1,8 @@
+
+Service
+-------
+.. automodule:: service
+  :members:
+  :undoc-members:
+  :show-inheritance:
+  :exclude-members: MODEL_TYPE, DEBUG, MODEL_NAME, ENVIRONMENT, SERVICE_START_TIMESTAMP, app, model

docsrc/source/sklearn_model.rst

@@ -0,0 +1,6 @@
+Scikit-learn Model
+~~~~~~~~~~~~~~~~~~
+.. automodule:: python.model.sklearn
+  :members:
+  :undoc-members:
+  :show-inheritance:

python/model/base.py

@@ -62,7 +62,7 @@ def __repr__(self):
 
 
 class BaseModel(object):
-    """Base Class that handles the loaded model."""
+    """Abstract class that handles the loaded model."""
     family = ''
     # Explainable models
     _explainable_models = tuple()
@@ -77,30 +77,37 @@ def __init__(self, file_name):
 
     # Abstract
     def _load(self):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check()
     def _get_predictor(self):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check(task='classification')
     def _get_class_names(self):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check()
     def preprocess(self, features):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check()
     def predict(self, features):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check(task='classification')
     def predict_proba(self, features):
+        """Abstract method"""
         raise NotImplementedError()
 
     @_check(explainable=True)
     def explain(self, features, samples=None):
+        """Abstract method"""
         raise NotImplementedError()
 
     # Private