From d25a5746b870f350d11a2f87709f9b9862546763 Mon Sep 17 00:00:00 2001 From: Natasha Dsouza Date: Fri, 3 Jan 2020 14:43:19 -0800 Subject: [PATCH] Docs: Story telling readme --- modules/storytelling/README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/modules/storytelling/README.md b/modules/storytelling/README.md index 70f05fa1fe2..6c4c506d5bf 100644 --- a/modules/storytelling/README.md +++ b/modules/storytelling/README.md @@ -1,8 +1,23 @@ # Storytelling -Storytelling is a new module as a part of Project Lego. It is a global and high -level Scenario Manager to help coordinate cross-module actions. +## Introduction +Storytelling is a global and high-level Scenario Manager to help coordinate cross-module actions. In order to safely operate the autonomous vehicle on urban roads, complex planning scenarios are needed to ensure safe driving. These complex scenarios may involve different modules to ensure proper maneuvering. In order to avoid a sequential based approach to such scenarios, a new isolated scenario manager, the "Story Telling" module was created. This module creates stories which are complex scenarios that would trigger multiple modules' actions. Per some predefined rules, this module creates ne or multiple stories and publishes to +`/apollo/storytelling` channel. The main advantage of this module is to fine tune the driving experience and also isolate complex scenarios packaging them into stories that can be subscribed to by other modules like Planning, Control etc. -It selects criteria to decide one or multiple stories and publishes to -`/apollo/storytelling` channel. A story is a high level scenario for the whole -system which could trigger multiple modules' actions. +## Input + +* Localization +* HD Map + +## Output + +* Story - which can be subscribed to by other modules + +## Sample Story + +Please refer to [CloseToJunction](https://github.com/ApolloAuto/apollo/tree/master/modules/storytelling/story_tellers) sample scenario to understand the Story Telling module + +``` +Note: +The base_teller.h is a virtual class to help you implement your own story. Please inherit this class when writing your own story. +``` \ No newline at end of file