Skip to content

Commit d25a574

Browse files
natashadsouzaxiaoxq
authored andcommitted
Docs: Story telling readme
1 parent 09a4f00 commit d25a574

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

modules/storytelling/README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# Storytelling
22

3-
Storytelling is a new module as a part of Project Lego. It is a global and high
4-
level Scenario Manager to help coordinate cross-module actions.
3+
## Introduction
4+
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
5+
`/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.
56

6-
It selects criteria to decide one or multiple stories and publishes to
7-
`/apollo/storytelling` channel. A story is a high level scenario for the whole
8-
system which could trigger multiple modules' actions.
7+
## Input
8+
9+
* Localization
10+
* HD Map
11+
12+
## Output
13+
14+
* Story - which can be subscribed to by other modules
15+
16+
## Sample Story
17+
18+
Please refer to [CloseToJunction](https://github.com/ApolloAuto/apollo/tree/master/modules/storytelling/story_tellers) sample scenario to understand the Story Telling module
19+
20+
```
21+
Note:
22+
The base_teller.h is a virtual class to help you implement your own story. Please inherit this class when writing your own story.
23+
```

0 commit comments

Comments
 (0)