From d09defff0a2a4bf2ab0dc248317b774bacea4339 Mon Sep 17 00:00:00 2001 From: Piotr Spieker Date: Tue, 26 Nov 2024 18:56:57 +0100 Subject: [PATCH] Fix numbering of tutorial tasks --- README.md | 6 +++--- docs/Tutorial.md | 10 +++++----- docs/tasks/2_extend_arbitration_graph.md | 2 +- ...4_nested_arbitrators.md => 3_nested_arbitrators.md} | 6 +++--- .../{5_cost_arbitration.md => 4_cost_arbitration.md} | 8 ++++---- docs/tasks/{6_verification.md => 5_verification.md} | 4 ++-- 6 files changed, 18 insertions(+), 18 deletions(-) rename docs/tasks/{4_nested_arbitrators.md => 3_nested_arbitrators.md} (96%) rename docs/tasks/{5_cost_arbitration.md => 4_cost_arbitration.md} (97%) rename docs/tasks/{6_verification.md => 5_verification.md} (99%) diff --git a/README.md b/README.md index 682539a..7a4d214 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,9 @@ It's based on this demo and guides you through all important concepts: 0. [Introduction – start here!](./docs/Tutorial.md) 1. [Implement your first behavior component](./docs/tasks/1_implement_behavior_component.md) 2. [Extend the arbitration graph with that behavior](./docs/tasks/2_extend_arbitration_graph.md) -3. [Learn about nested arbitration graphs](./docs/tasks/4_nested_arbitrators.md) -4. [Arbitrate based on predicted utility](./docs/tasks/5_cost_arbitration.md) -5. [Verify commands and add a fallback strategy](./docs/tasks/6_verification.md) +3. [Learn about nested arbitration graphs](./docs/tasks/3_nested_arbitrators.md) +4. [Arbitrate based on predicted utility](./docs/tasks/4_cost_arbitration.md) +5. [Verify commands and add a fallback strategy](./docs/tasks/5_verification.md) ## Installation diff --git a/docs/Tutorial.md b/docs/Tutorial.md index 73cefcd..e3a8309 100644 --- a/docs/Tutorial.md +++ b/docs/Tutorial.md @@ -114,9 +114,9 @@ You guessed it, it contains the environment model for the arbitration graph. In it, we store things like current positions of Pac-Man and the ghosts, the maze, several utility functions and other things required by the behavior components. -The `cost_estimator.hpp` file will be relevant for a later task when we cover [cost arbitrators](./tasks/5_cost_arbitration.md). +The `cost_estimator.hpp` file will be relevant for a later task when we cover [cost arbitrators](./tasks/4_cost_arbitration.md). -Similarly, the `verifier.hpp` file will be used to add a verification layer to the arbitration graph [near the end](./tasks/6_verification.md) of the tutorial. +Similarly, the `verifier.hpp` file will be used to add a verification layer to the arbitration graph [near the end](./tasks/5_verification.md) of the tutorial. Finally, in `pacman_agent.hpp`, the behavior components are assembled into an arbitration graph. It's also where you'll spend most of your time during this tutorial. @@ -131,6 +131,6 @@ With the basics out of the way, let's work through the tasks. 1. [Implement your first behavior component](./tasks/1_implement_behavior_component.md) 2. [Extend the arbitration graph with that behavior](./tasks/2_extend_arbitration_graph.md) -3. [Learn about nested arbitration graphs](./tasks/4_nested_arbitrators.md) -4. [Arbitrate based on predicted utility](./tasks/5_cost_arbitration.md) -5. [Verify commands and add a fallback strategy](./tasks/6_verification.md) +3. [Learn about nested arbitration graphs](./tasks/3_nested_arbitrators.md) +4. [Arbitrate based on predicted utility](./tasks/4_cost_arbitration.md) +5. [Verify commands and add a fallback strategy](./tasks/5_verification.md) diff --git a/docs/tasks/2_extend_arbitration_graph.md b/docs/tasks/2_extend_arbitration_graph.md index a2ba773..45c2120 100644 --- a/docs/tasks/2_extend_arbitration_graph.md +++ b/docs/tasks/2_extend_arbitration_graph.md @@ -82,4 +82,4 @@ explicit PacmanAgent(const entt::Game& game) | [Tutorial Home](../Tutorial.md) | -[Next task →](4_nested_arbitrators.md) +[Next task →](3_nested_arbitrators.md) diff --git a/docs/tasks/4_nested_arbitrators.md b/docs/tasks/3_nested_arbitrators.md similarity index 96% rename from docs/tasks/4_nested_arbitrators.md rename to docs/tasks/3_nested_arbitrators.md index 9a8f24b..1a5cc78 100644 --- a/docs/tasks/4_nested_arbitrators.md +++ b/docs/tasks/3_nested_arbitrators.md @@ -3,7 +3,7 @@ title: "Arbitration Graphs Tutorial" menu_title: "Nesting" --- -# Task 4: Nested arbitration graphs +# Task 3: Nested arbitration graphs Integrate a long-term behavior and add another layer to the arbitration graph. @@ -18,7 +18,7 @@ The `ChangeDotCluster` behavior will move Pac-man to an area in the maze where t For now, we'll just decide between the two dot eating strategies using chance. We can achieve that by adding them to a random arbitrator which is then added as an option to the root arbitrator. -There are more sophisticated ways to decide between behavior components, we'll cover those in the [next task](5_cost_arbitration.md). +There are more sophisticated ways to decide between behavior components, we'll cover those in the [next task](4_cost_arbitration.md). ## Goal @@ -94,4 +94,4 @@ explicit PacmanAgent(const entt::Game& game) | [Tutorial Home](../Tutorial.md) | -[Next task →](5_cost_arbitration.md) +[Next task →](4_cost_arbitration.md) diff --git a/docs/tasks/5_cost_arbitration.md b/docs/tasks/4_cost_arbitration.md similarity index 97% rename from docs/tasks/5_cost_arbitration.md rename to docs/tasks/4_cost_arbitration.md index 4941652..8274515 100644 --- a/docs/tasks/5_cost_arbitration.md +++ b/docs/tasks/4_cost_arbitration.md @@ -3,13 +3,13 @@ title: "Arbitration Graphs Tutorial" menu_title: "Cost Arbitrator" --- -# Task 5: Arbitrate based on predicted utility +# Task 4: Arbitrate based on predicted utility Learn how the cost arbitrator can help you to arbitrate between behaviors based on their expected cost/utility. ## Context -The `EatDot` arbitrator we added in the [previous task](4_nested_arbitrators.md) decides between the two dot eating strategies randomly. +The `EatDot` arbitrator we added in the [previous task](3_nested_arbitrators.md) decides between the two dot eating strategies randomly. That's obviously not the greatest idea. There must be a better way. @@ -140,8 +140,8 @@ explicit PacmanAgent(const entt::Game& game) --- -[← Previous task](4_nested_arbitrators.md) +[← Previous task](3_nested_arbitrators.md) | [Tutorial Home](../Tutorial.md) | -[Next task →](6_verification.md) +[Next task →](5_verification.md) diff --git a/docs/tasks/6_verification.md b/docs/tasks/5_verification.md similarity index 99% rename from docs/tasks/6_verification.md rename to docs/tasks/5_verification.md index f0b5ba6..f24a834 100644 --- a/docs/tasks/6_verification.md +++ b/docs/tasks/5_verification.md @@ -3,7 +3,7 @@ title: "Arbitration Graphs Tutorial" menu_title: "Verification and Fallbacks" --- -# Task 6: Better safe than sorry +# Task 5: Better safe than sorry Execute only safe commands and add a fallback strategy. @@ -141,6 +141,6 @@ Make sure to also pass the verifier to the arbitrator constructors: --- -[← Previous task](5_cost_arbitration.md) +[← Previous task](4_cost_arbitration.md) | [Tutorial Home](../Tutorial.md)