Merge pull request #538 from sibyl-dev/quickstart_tutorial

Cleaning up quickstart and tutorials
sibyl-dev · Mar 20, 2024 · c647a09 · c647a09
2 parents 6d8fd84 + 650a873
commit c647a09
Show file tree

Hide file tree

Showing 17 changed files with 353 additions and 628 deletions.
diff --git a/pyreal/sample_applications/titanic.py b/pyreal/sample_applications/titanic.py
@@ -96,6 +96,9 @@ def load_transformers(save=False, use_saved=False):
 
 
 def load_app(n_rows=None):
+    def pred_format_func(pred):
+        return "Survived" if pred else "Died"
+
     x_train_orig, y = load_data(include_targets=True, n_rows=n_rows)
     model = load_model()
     transformers = load_transformers()
@@ -107,4 +110,5 @@ def load_app(n_rows=None):
         y_train=y,
         transformers=transformers,
         feature_descriptions=feature_descriptions,
+        pred_format_func=pred_format_func,
     )
diff --git a/...rials/ames_housing/ames_housing_lfc.ipynb → tutorials/ames_housing_example.ipynb b/...rials/ames_housing/ames_housing_lfc.ipynb → tutorials/ames_housing_example.ipynb
diff --git a/tutorials/basic_explanation_generation.ipynb b/tutorials/basic_explanation_generation.ipynb
diff --git a/tutorials/demos/demo2_housing.ipynb b/tutorials/demos/demo2_housing.ipynb
diff --git a/tutorials/demos/using_pyreal.ipynb b/tutorials/demos/using_pyreal.ipynb
diff --git a/...als/advanced_explanation_generation.ipynb → ...als/advanced_explanation_generation.ipynb b/...als/advanced_explanation_generation.ipynb → ...als/advanced_explanation_generation.ipynb
diff --git a/tutorials/custom_transformers.ipynb → ...loper_tutorials/custom_transformers.ipynb b/tutorials/custom_transformers.ipynb → ...loper_tutorials/custom_transformers.ipynb
diff --git a/tutorials/data/arrowhead/ArrowHead.txt → ...er_tutorials/data/arrowhead/ArrowHead.txt b/tutorials/data/arrowhead/ArrowHead.txt → ...er_tutorials/data/arrowhead/ArrowHead.txt
diff --git a/...rials/data/arrowhead/ArrowHead_readme.txt → ...rials/data/arrowhead/ArrowHead_readme.txt b/...rials/data/arrowhead/ArrowHead_readme.txt → ...rials/data/arrowhead/ArrowHead_readme.txt
diff --git a/tutorials/data/california_housing.model → ...r_tutorials/data/california_housing.model b/tutorials/data/california_housing.model → ...r_tutorials/data/california_housing.model
diff --git a/tutorials/data/trinket/feature_types.png → ..._tutorials/data/trinket/feature_types.png b/tutorials/data/trinket/feature_types.png → ..._tutorials/data/trinket/feature_types.png
diff --git a/.../data/trinket/generate_trinket_data.ipynb → .../data/trinket/generate_trinket_data.ipynb b/.../data/trinket/generate_trinket_data.ipynb → .../data/trinket/generate_trinket_data.ipynb
diff --git a/tutorials/data/trinket/trinket_data.csv → ...r_tutorials/data/trinket/trinket_data.csv b/tutorials/data/trinket/trinket_data.csv → ...r_tutorials/data/trinket/trinket_data.csv
diff --git a/...rials/plot_based/partial_dependence.ipynb → ...eloper_tutorials/partial_dependence.ipynb b/...rials/plot_based/partial_dependence.ipynb → ...eloper_tutorials/partial_dependence.ipynb
diff --git a/tutorials/time_series_basic.ipynb → ...veloper_tutorials/time_series_basic.ipynb b/tutorials/time_series_basic.ipynb → ...veloper_tutorials/time_series_basic.ipynb
diff --git a/tutorials/quickstart.ipynb b/tutorials/quickstart.ipynb
diff --git a/tutorials/user_guide.ipynb b/tutorials/user_guide.ipynb
@@ -199,7 +199,10 @@
    "source": [
     "## Modelling\n",
     "\n",
-    "We can now transform our training and testing data, and initialize, train, and evaluate our ML model."
+    "We can now transform our training and testing data, and initialize, train, and evaluate our ML model.\n",
+    "\n",
+    "In this guide, we will use LightGBM, a powerful and lightweight library that offers classfiers and regressors using the gradient boosting framework. \n",
+    "It is an effective choice for many ML use cases."
    ],
    "metadata": {
     "collapsed": false