Document Model.__init__

siboehm · Jun 26, 2021 · b59ac95 · b59ac95
1 parent dab9bf0
commit b59ac95
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,3 +17,5 @@ lleaves 🍃
    :members:
    :noindex:
 
+   .. automethod:: __init__
+
diff --git a/lleaves/lleaves.py b/lleaves/lleaves.py
@@ -21,6 +21,10 @@ class pd_DataFrame:
 
 
 class Model:
+    """
+    The base class of lleaves.
+    """
+
     # machine-targeted compiler & exec engine.
     _execution_engine = None
 
@@ -32,6 +36,8 @@ class Model:
 
     def __init__(self, model_file=None):
         """
+        Initialize the uncompiled model.
+
         :param model_file: Path to the model.txt.
         """
         self.model_file = model_file