Paul-Edouard Sarlin commited on
Commit
8c81aa4
·
unverified ·
1 Parent(s): 0689390

Improve documentation

Browse files
Files changed (1) hide show
  1. README.md +18 -8
README.md CHANGED
@@ -101,22 +101,30 @@ Recall yaw_max_error: [20.95, 54.96, 70.17] at (1, 3, 5) m/°
101
  This requires a GPU with 11GB of memory. If you run into OOM issues, consider reducing the number of rotations (the default is 256):
102
 
103
  ```bash
104
- python -m maploc.evaluation.mapillary --experiment OrienterNet_MGL \
105
- model.num_rotations=128
106
  ```
107
 
108
  To export visualizations for the first 100 examples:
109
 
110
  ```bash
111
- python -m maploc.evaluation.mapillary --experiment OrienterNet_MGL \
112
- --output_dir ./viz_MGL/ --num 100
113
  ```
114
 
115
- To run the evaluation in sequential mode (by default with 10 frames):
116
 
117
  ```bash
118
  python -m maploc.evaluation.mapillary --experiment OrienterNet_MGL --sequential
119
  ```
 
 
 
 
 
 
 
 
 
 
120
 
121
  </details>
122
 
@@ -147,9 +155,9 @@ Recall yaw_max_error: [29.22, 68.2, 84.49] at (1, 3, 5) m/°
147
  You can similarly export some visual examples:
148
 
149
  ```bash
150
- python -m maploc.evaluation.kitti --experiment OrienterNet_MGL \
151
- --output_dir ./viz_KITTI/ --num 100
152
  ```
 
153
 
154
  </details>
155
 
@@ -206,7 +214,9 @@ We provide several visualization notebooks:
206
  <details>
207
  <summary>[Click to expand]</summary>
208
 
209
- To make sure that the results are consistent over time, we used OSM data downloaded from [Geofabrik](https://download.geofabrik.de/) in November 2021. By default, the dataset scripts `maploc.data.[mapillary,kitti].prepare` download pre-generated raster tiles. If you wish to use different OSM classes, you can pass `--generate_tiles`, which will download and use our prepared raw `.osm` XML files. You may alternatively download more recent files.
 
 
210
 
211
  </details>
212
 
 
101
  This requires a GPU with 11GB of memory. If you run into OOM issues, consider reducing the number of rotations (the default is 256):
102
 
103
  ```bash
104
+ python -m maploc.evaluation.mapillary [...] model.num_rotations=128
 
105
  ```
106
 
107
  To export visualizations for the first 100 examples:
108
 
109
  ```bash
110
+ python -m maploc.evaluation.mapillary [...] --output_dir ./viz_MGL/ --num 100
 
111
  ```
112
 
113
+ To run the evaluation in sequential mode:
114
 
115
  ```bash
116
  python -m maploc.evaluation.mapillary --experiment OrienterNet_MGL --sequential
117
  ```
118
+ The results should be close to the following:
119
+ ```
120
+ Recall xy_seq_error: [29.73, 73.25, 91.17] at (1, 3, 5) m/°
121
+ Recall yaw_seq_error: [46.55, 88.3, 96.45] at (1, 3, 5) m/°
122
+ ```
123
+ The sequential evaluation uses 10 frames by default. To increase this number:
124
+ ```bash
125
+ python -m maploc.evaluation.mapillary [...] --sequential chunking.max_length=20
126
+ ```
127
+
128
 
129
  </details>
130
 
 
155
  You can similarly export some visual examples:
156
 
157
  ```bash
158
+ python -m maploc.evaluation.kitti [...] --output_dir ./viz_KITTI/ --num 100
 
159
  ```
160
+ To run in sequential mode, similarly add the `--sequential` flag.
161
 
162
  </details>
163
 
 
214
  <details>
215
  <summary>[Click to expand]</summary>
216
 
217
+ To make sure that the results are consistent over time, we used OSM data downloaded from [Geofabrik](https://download.geofabrik.de/) in November 2021. By default, the dataset scripts `maploc.data.[mapillary,kitti].prepare` download pre-generated raster tiles. If you wish to use different OSM classes, you can pass `--generate_tiles`, which will download and use our prepared raw `.osm` XML files.
218
+
219
+ You may alternatively download more recent files from [Geofabrik](https://download.geofabrik.de/). Download either compressed XML files as `.osm.bz2` or binary files `.osm.pbf`, which need to be converted to XML files `.osm`, for example using Osmium: ` osmium cat xx.osm.pbf -o xx.osm`.
220
 
221
  </details>
222