docs: update heuristics notebook

justindujardin · Jan 23, 2024 · 6beb9d7 · 6beb9d7
1 parent 7d0cf5f
commit 6beb9d7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/website/docs/examples/heuristics.ipynb b/website/docs/examples/heuristics.ipynb
@@ -12,9 +12,11 @@
     "\n",
     "While having a program that outputs `20x + y` directly is convenient, understanding the step-by-step transformation is invaluable for learning and problem-solving.\n",
     "\n",
-    "Let's explore how [mathy_core](https://core.mathy.ai) parses input text into a tree structure, and then applies transformations to simplify the tree into a solution. \n",
+    "Let's explore how [mathy_core](https://core.mathy.ai) parses input text into a tree structure, and then applies transformations to simplify the tree into a solution. In this notebook, we use a simple, heuristic approach to demonstrate the API's functionality. The heuristics applied here are intentionally basic, serving as a foundational tool for beginners and a clear illustration of the API in action. \n",
     "\n",
-    "You'll see not just the end result but each step we take to get there - a valuable tool for both students and educators alike."
+    "This approach is perfect for educational purposes, allowing you to not just see the end result but also to understand each step we take to get there.\n",
+    "\n",
+    "> Please note: The heuristic methods used in this notebook are designed for simplicity and educational demonstration. They may not represent the most efficient or sophisticated problem-solving strategies but are chosen for their ease of understanding and effectiveness in illustrating basic concepts.\n"
    ]
   },
   {

diff --git a/website/docs/examples/heuristics.md b/website/docs/examples/heuristics.md
@@ -6,9 +6,12 @@ Remember the challenges in Algebra of combining like terms to simplify expressio
 
 While having a program that outputs `20x + y` directly is convenient, understanding the step-by-step transformation is invaluable for learning and problem-solving.
 
-Let's explore how [mathy_core](https://core.mathy.ai) parses input text into a tree structure, and then applies transformations to simplify the tree into a solution. 
+Let's explore how [mathy_core](https://core.mathy.ai) parses input text into a tree structure, and then applies transformations to simplify the tree into a solution. In this notebook, we use a simple, heuristic approach to demonstrate the API's functionality. The heuristics applied here are intentionally basic, serving as a foundational tool for beginners and a clear illustration of the API in action. 
+
+This approach is perfect for educational purposes, allowing you to not just see the end result but also to understand each step we take to get there.
+
+> Please note: The heuristic methods used in this notebook are designed for simplicity and educational demonstration. They may not represent the most efficient or sophisticated problem-solving strategies but are chosen for their ease of understanding and effectiveness in illustrating basic concepts.
 
-You'll see not just the end result but each step we take to get there - a valuable tool for both students and educators alike.
 
 
 ```python

diff --git a/website/docs/examples/mathy_ppo.md b/website/docs/examples/mathy_ppo.md
@@ -212,7 +212,7 @@ class ActorCritic(nn.Module):
 
 ### Algorithm
 
-The PPO class handles policy updates, action selection, experience buffer handling, and saving/loading.
+The PPO class encapsulates handles the policy updates, action selection, experience buffer handling, and saving/loading.
 
 It initializes two ActorCritic models: one for the current policy and another as a reference to the old policy. This structure is crucial for implementing PPO's clipped surrogate objective function, which moderates the policy updates for stability.