minor fix

anhquan0412 · Jul 15, 2024 · 643c6a3 · 643c6a3
1 parent bef1b6e
commit 643c6a3
Show file tree

Hide file tree

Showing 6 changed files with 2,949 additions and 521 deletions.
diff --git a/nbs/02_ml_helpers.ipynb b/nbs/02_ml_helpers.ipynb
@@ -133,7 +133,7 @@
        ">                               multi_class='multinomial', solver='newton-cg',\n",
        ">                               penalty=None, max_iter=10000, return_coef=False)\n",
        "\n",
-       "Perform Sklearn logistic regression, then print coefficients and classification report\n",
+       "*Perform Sklearn logistic regression, then print coefficients and classification report*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",
@@ -157,7 +157,7 @@
        ">                               multi_class='multinomial', solver='newton-cg',\n",
        ">                               penalty=None, max_iter=10000, return_coef=False)\n",
        "\n",
-       "Perform Sklearn logistic regression, then print coefficients and classification report\n",
+       "*Perform Sklearn logistic regression, then print coefficients and classification report*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",
@@ -215,15 +215,15 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L71){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L67){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### run_multinomial_statmodel\n",
        "\n",
        ">      run_multinomial_statmodel (X_trn:pandas.core.frame.DataFrame,\n",
        ">                                 y_trn:pandas.core.series.Series|numpy.ndarray,\n",
        ">                                 add_constant=True)\n",
        "\n",
-       "Perform multinominal logit from statsmodel, then print results and classification report\n",
+       "*Perform multinominal logit from statsmodel, then print results and classification report*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",
@@ -234,15 +234,15 @@
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L71){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L67){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### run_multinomial_statmodel\n",
        "\n",
        ">      run_multinomial_statmodel (X_trn:pandas.core.frame.DataFrame,\n",
        ">                                 y_trn:pandas.core.series.Series|numpy.ndarray,\n",
        ">                                 add_constant=True)\n",
        "\n",
-       "Perform multinominal logit from statsmodel, then print results and classification report\n",
+       "*Perform multinominal logit from statsmodel, then print results and classification report*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",
@@ -329,11 +329,9 @@
     "            \n",
     "            # plot residual plot\n",
     "            plot_residuals(_model,X_trn,y_trn,X_test,y_test,\n",
-    "                           is_fit=True,\n",
     "                           qqplot=True)\n",
     "        else:\n",
     "            plot_residuals(_model,X_trn,y_trn,\n",
-    "                           is_fit=True,\n",
     "                           qqplot=True)\n",
     "\n",
     "    # For classification\n",
@@ -376,7 +374,7 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L90){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L86){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### run_sklearn_model\n",
        "\n",
@@ -403,7 +401,7 @@
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L90){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L86){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### run_sklearn_model\n",
        "\n",
@@ -497,7 +495,7 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L189){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L183){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### tune_sklearn_model\n",
        "\n",
@@ -508,7 +506,7 @@
        ">                          random_cv_iter=None, scoring=None, seed=42,\n",
        ">                          rank_show=10, show_split_scores=True)\n",
        "\n",
-       "Perform either Sklearn's Grid Search or Randomized Search (based on random_cv_iter) of the model using param_grid\n",
+       "*Perform either Sklearn's Grid Search or Randomized Search (based on random_cv_iter) of the model using param_grid*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",
@@ -527,7 +525,7 @@
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L189){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
+       "[source](https://github.com/anhquan0412/that-ml-library/blob/main/that_ml_library/ml_helpers.py#L183){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
        "\n",
        "### tune_sklearn_model\n",
        "\n",
@@ -538,7 +536,7 @@
        ">                          random_cv_iter=None, scoring=None, seed=42,\n",
        ">                          rank_show=10, show_split_scores=True)\n",
        "\n",
-       "Perform either Sklearn's Grid Search or Randomized Search (based on random_cv_iter) of the model using param_grid\n",
+       "*Perform either Sklearn's Grid Search or Randomized Search (based on random_cv_iter) of the model using param_grid*\n",
        "\n",
        "|    | **Type** | **Default** | **Details** |\n",
        "| -- | -------- | ----------- | ----------- |\n",

diff --git a/nbs/03_chart_plotting.ipynb b/nbs/03_chart_plotting.ipynb
diff --git a/nbs/sidebar.yml b/nbs/sidebar.yml
@@ -2,6 +2,7 @@ website:
   sidebar:
     contents:
       - index.ipynb
+      - 00_end_to_end_example.ipynb
       - 01_data_preprocess.ipynb
       - 02_ml_helpers.ipynb
       - 03_chart_plotting.ipynb

diff --git a/settings.ini b/settings.ini
@@ -5,8 +5,8 @@
 ### Python library ###
 repo = that-ml-library
 lib_name = %(repo)s
-version = 0.0.5
-min_python = 3.8
+version = 0.0.6
+min_python = 3.9
 license = apache2
 black_formatting = False
 

diff --git a/that_ml_library/__init__.py b/that_ml_library/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.5"
+__version__ = "0.0.6"
diff --git a/that_ml_library/ml_helpers.py b/that_ml_library/ml_helpers.py
@@ -145,11 +145,9 @@ def run_sklearn_model(model_name:str, # sklearn's Machine Learning model to try.
 
             # plot residual plot
             plot_residuals(_model,X_trn,y_trn,X_test,y_test,
-                           is_fit=True,
                            qqplot=True)
         else:
             plot_residuals(_model,X_trn,y_trn,
-                           is_fit=True,
                            qqplot=True)
 
     # For classification