From b59ac9501574bcbe564c12004431371bd40f5ac0 Mon Sep 17 00:00:00 2001 From: Simon Boehm Date: Sat, 26 Jun 2021 10:05:19 +0200 Subject: [PATCH] Document Model.__init__ --- docs/index.rst | 2 ++ lleaves/lleaves.py | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 50ce12c..a478b0a 100644 --- 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 index 2e5f9f6..aa7cd5c 100644 --- 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