From ec1eb954c97d7269ef76d5eee82d8f68698e0a94 Mon Sep 17 00:00:00 2001 From: Sergio Paniego Blanco Date: Wed, 20 Sep 2023 12:02:42 +0200 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3f4f6a5c..2b4f41de 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ Each task comes with its own custom evaluation metrics that can help compare aut The main component of the ego vehicle is the brain, which receives sensor data, manipulates it, and generates robot control commands based on it. The inner part of the brain can be controlled by an end-to-end model, written in Tensorflow or PyTorch, a reinforcement learning policy, or even an explicitly programmed policy. +The software provides two main pipelines, a graphical user interface (GUI) and a headless mode (scripted). +The first one is intended for testing one brain+model at a time and debugging it visually while the headless mode is intended for running lots of experiments at the same time for comparison of a batch of brain+models in different scenarios. + architecture ### Installation @@ -25,24 +28,30 @@ For more information about the project and how to install it, you can consult th We provide examples for the follow-lane task using CARLA: -* For an example of a robot brain using a Tensorflow model for control, run: +* For an example of a robot brain using a Tensorflow model for control with GUI pipeline, run: ``` python3 driver_carla.py -c configs/CARLA/default_carla_tensorflow.yml -g ``` -* For an example of a robot brain using a PyTorch model for control, run: +* For an example of a robot brain using a PyTorch model for control with GUI pipeline, run: ``` python3 driver_carla.py -c configs/CARLA/default_carla_torch.yml -g ``` -* For an example of an explicitly programmed robot brain, run: +* For an example of an explicitly programmed robot brain with GUI pipeline, run: ``` python3 driver_carla.py -c configs/CARLA/default_carla.yml -g ``` +* For an example of the headless pipeline, run: + +``` +python3 driver_carla.py -c configs/CARLA/default_carla_multiple.yml -g +``` + ### Contributing to the project If you want to contribute, please first check out [CONTRIBUTING.md](CONTRIBUTING.md) section.