Add tutorial notebook explaining simulation step by step (#132)

BCG-X-Official · Nov 3, 2020 · a6e2a91 · a6e2a91
1 parent dbd2e82
commit a6e2a91
Show file tree

Hide file tree

Showing 9 changed files with 4,527 additions and 3,112 deletions.
diff --git a/sphinx/source/_static/Facet-Simulator-BlockDiagram.png b/sphinx/source/_static/Facet-Simulator-BlockDiagram.png
diff --git a/sphinx/source/tutorial/Classification_Water_Drilling_Simulation.ipynb b/sphinx/source/tutorial/Classification_Water_Drilling_Simulation.ipynb
diff --git a/sphinx/source/tutorial/Classification_simulation_example_Facet.ipynb b/sphinx/source/tutorial/Classification_simulation_example_Facet.ipynb
diff --git a/sphinx/source/tutorial/Classification_with_Facet.ipynb b/sphinx/source/tutorial/Classification_with_Facet.ipynb
diff --git a/sphinx/source/tutorial/Model_simulation_deep_dive.ipynb b/sphinx/source/tutorial/Model_simulation_deep_dive.ipynb
diff --git a/sphinx/source/tutorial/Predictive_Maintenance_Regression_with_Facet.ipynb b/sphinx/source/tutorial/Predictive_Maintenance_Regression_with_Facet.ipynb
diff --git a/sphinx/source/tutorial/Synergy_Redundancy_Tutorial_with_Facet.ipynb b/sphinx/source/tutorial/Synergy_Redundancy_Tutorial_with_Facet.ipynb
diff --git a/sphinx/source/tutorial/Water_Drilling_Incident_Classification_with_Facet.ipynb b/sphinx/source/tutorial/Water_Drilling_Incident_Classification_with_Facet.ipynb
diff --git a/sphinx/source/tutorials.rst b/sphinx/source/tutorials.rst
@@ -28,8 +28,8 @@ Introduce yourself to the FACET workflow! With this tutorial you will:
 
 .. raw:: html
 
-    <p>Get started exploring the tutorial below by clicking on the section links,
-    deepen your understanding by reading the associated Gamma Scope article (click here),
+    <p>Start exploring the tutorial below by clicking on the section links,
+    deepen your understanding by reading the associated GAMMA Scope article (click here),
     and explore/download the notebook for yourself here:
     <a href="https://mybinder.org" target="_blank">
     <img src="https://mybinder.org/badge_logo.svg"></a>
@@ -39,8 +39,7 @@ Introduce yourself to the FACET workflow! With this tutorial you will:
 .. toctree::
     :maxdepth: 1
 
-    tutorial/Classification_Water_Drilling_Simulation
-
+    tutorial/Water_Drilling_Incident_Classification_with_Facet
 
 
 Regression Tutorial: Predictive Maintenance
@@ -92,14 +91,39 @@ identification of individuals at risk of prediabetes you will
    tutorial/Classification_with_Facet
 
 
+Simulation Tutorial: Feature Simulation on Drill Operations
+*****************************************************************************
+
+Introduce yourself to the FACET's Simulation module. This tutorial aims to provide
+a step by step explanation about the simulation capabilities of Facet and
+is based on the Water Drilling Tutorial.
+
+.. raw:: html
+
+    <p>Start exploring the tutorial below by clicking on the section links,
+    deepen your understanding by reading the associated GAMMA Scope article (click here),
+    and explore/download the notebook for yourself here:
+    <a href="https://mybinder.org" target="_blank">
+    <img src="https://mybinder.org/badge_logo.svg"></a>
+    </p>
+
+
+
+.. toctree::
+    :maxdepth: 1
+
+    tutorial/Model_simulation_deep_dive.ipynb
+
+
+
 Bite-sized Simulations
 --------------------------------------------
 
-Understanding synergy and redundancy through simulation
+Understanding synergy and redundancy with synthetic data
 *************************************************************
 
-Improve your intuition for FACET's advanced model inspection with this simulation based
-tutorial. In this tutorial you will:
+Improve your intuition for FACET's advanced model inspection with this tutorial.
+In this tutorial you will:
 
 - understand how synergy and redundancy for a feature pair varies with interaction and
   correlation, and,
@@ -118,4 +142,4 @@ tutorial. In this tutorial you will:
 .. toctree::
     :maxdepth: 1
 
-    tutorial/Classification_simulation_example_Facet
+    tutorial/Synergy_Redundancy_Tutorial_with_Facet