Skip to content

Commit cdbe5e1

Browse files
committed
Update README
1 parent 2dff71a commit cdbe5e1

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,16 @@ We propose "**E**fficiency through **T**hinking **A**head" (ETA), an asynchronou
2424

2525
## Getting Started <a name="gettingstarted"></a>
2626

27-
Please refer to [TRAIN_EVAL.md](docs/TRAIN_EVAL.md) for detailed instructions on how to train and evaluate the model.
27+
To get started with ETA:
28+
- Training
29+
- [Download Bench2Drive Data](docs/TRAIN_EVAL.md#b2ddata)
30+
- [Setup other prerequisites](docs/TRAIN_EVAL.md#trainingsetup)
31+
- [Start training](docs/TRAIN_EVAL.md#training)
32+
- Evaluation
33+
- [Setup Bench2Drive](docs/TRAIN_EVAL.md#evalsetup)
34+
- [Setup files and configs](docs/TRAIN_EVAL.md#evalfilesetup)
35+
- [Download checkpoints](docs/TRAIN_EVAL.md#evalcheckpoints)
36+
- [Run evaluation](docs/TRAIN_EVAL.md#runeval)
2837

2938
## TODO List
3039
- [x] ETA Training code

docs/TRAIN_EVAL.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
## Training Setup <a name="trainingsetup"></a>
2-
### Bench2Drive data
3-
Download the [Bench2Drive](https://github.com/Thinklab-SJTU/Bench2Drive) dataset and unzip all the directories.
2+
### Bench2Drive data <a name="b2ddata"></a>
3+
Download the [Bench2Drive](https://github.com/Thinklab-SJTU/Bench2Drive) dataset and unzip all the directories to a single folder. The dataset should have a structure similar to the following:
4+
5+
```
6+
MainFolder/
7+
HazardAtSideLaneTwoWays_Town12_Route1133_Weather15/
8+
ParkingCutIn_Town12_Route765_Weather11/
9+
```
410

511
### Libraries
612
Install the [skit](https://github.com/Shamdan17/skit) toolkit for distributed sampling and training wrappers. More dependencies are listed in the `requirements.txt` file. Install them using pip:
@@ -21,7 +27,7 @@ wandb_entity: WANDBUSERNAME
2127
2228
Furthermore, modify the Makefile to update the username to the config name you just created.
2329
24-
### Training
30+
### Training <a name="training"></a>
2531
2632
To train the base and async models on 8 nodes with 4 GPUs each, run the following commands from the `carformer` directory. We run these commands in a SLURM job. Directly using make will not properly parallelize the training across multiple nodes, so modify it accordingly if not working in a SLURM environment.
2733

@@ -36,7 +42,7 @@ make ETA_async_model_s42
3642

3743
[Bench2Drive](https://github.com/Thinklab-SJTU/Bench2Drive) is required for evaluation. Please follow the "Eval Tools" section.
3844

39-
### File setup:
45+
### File setup: <a name="evalfilesetup"></a>
4046

4147
Only follow these steps **AFTER** Bench2Drive is set up following the Bench2Drive instructions. Please place the files found in "misc" and "team_code" in the following structure in the Bench2Drive repo:
4248

@@ -64,11 +70,11 @@ working_dir: /path/to/Bench2Drive
6470
b2d_path: /path/to/Bench2Drive
6571
```
6672

67-
### Download checkpoints:
73+
### Download checkpoints: <a name="evalcheckpoints"></a>
6874

6975
Checkpoints uploading is in progress.
7076

71-
### Running the evaluation:
77+
### Running the evaluation: <a name="runeval"></a>
7278

7379
**Note:** Unlike Bench2Drive's setup, this evaluation code requires a separate instance of CARLA running. It will NOT run CARLA for you.
7480

0 commit comments

Comments
 (0)