PurpleSand commited on
Commit
b5fe40f
Β·
verified Β·
1 Parent(s): 849f7bd

Update README.md with eval directory documentation

Browse files
Files changed (1) hide show
  1. README.md +40 -8
README.md CHANGED
@@ -8,6 +8,17 @@ size_categories:
8
  - 1K<n<10K
9
  ---
10
  # COMMAND Dataset πŸ˜ƒ
 
 
 
 
 
 
 
 
 
 
 
11
  ## Dataset Structure πŸ—‚οΈ
12
 
13
  The **COMMAND_dataset** is organized as follows:
@@ -23,9 +34,14 @@ COMMAND_dataset/
23
  β”‚ └─ .yml # Map info (for ROS map server)
24
  β”œβ”€ bagfiles/ # Directory containing ROS bagfiles πŸŽ₯
25
  β”‚ └─ .bag # ROS bagfile with unique identifier
26
- └─ scenarios/ # Directory containing scenario information πŸ“œ
27
- β”œβ”€.json # Scenario schema
28
- └─.npy # Sketch instructions
 
 
 
 
 
29
  ```
30
 
31
  How to extract the dataset:
@@ -50,9 +66,12 @@ tar --use-compress-program=zstd -xf COMMAND.tar.zst
50
  | Avg. FD (P / M) | 1.05 / 1.77 | 0.97 / 2.02 | 3.03 / 3.50 | 1.91 / 3.76 |
51
  | % of Misleading | 31% | 51% | 50% | 39% |
52
 
53
- Total : 3317 bagfiles, includes 48 hours of driving data over 219 kilometers.
 
 
 
54
 
55
- **Note:** These values differ slightly from the paper because the data version history is missing.
56
 
57
  ## Directory Details πŸ—οΈ
58
 
@@ -69,6 +88,17 @@ Total : 3317 bagfiles, includes 48 hours of driving data over 219 kilometers.
69
  - **`<uuid>.json`**: Scenario schema file describing the scenario.
70
  - **`<uuid>.npy`**: Scenario annotations (sketch instructions). It contains a list of `(y, x)` pixel coordinates on the corresponding `sketch_map_name` map image.
71
 
 
 
 
 
 
 
 
 
 
 
 
72
  ---
73
 
74
  ### Topics in ROS Bagfiles πŸŽ₯
@@ -90,7 +120,7 @@ Total : 3317 bagfiles, includes 48 hours of driving data over 219 kilometers.
90
 
91
  5. **`/odom`**
92
  - **Message Type**: `nav_msgs/msg/Odometry`
93
- - **Description**: Offers an estimate of the robot’s position and velocity in free space. This serves as ground-truth data in simulation.
94
 
95
  6. **`/rgb_front/camera_info`, `/rgb_left/camera_info`, `/rgb_right/camera_info`**
96
  - **Message Type**: `sensor_msgs/msg/CameraInfo`
@@ -104,7 +134,9 @@ Total : 3317 bagfiles, includes 48 hours of driving data over 219 kilometers.
104
  - **Message Type**: `tf2_msgs/msg/TFMessage`
105
  - **Description**: Provides an odom-to-base_link transform.
106
 
107
- ### Schema of Scenario JSON πŸ“œ
 
 
108
  - **`semantic_uuid`**: A unique identifier for the scenario. Combines map name, scenario name, and either "precise" or "misleading," followed by the scenario number.
109
  - **`map_name`**: The name of the map where the scenario is located.
110
  - **`sketch_map_name`**: The map where the sketch instructions are provided.
@@ -135,4 +167,4 @@ If you find this work useful, please cite our paper:
135
  journal={arXiv preprint arXiv:2410.01273},
136
  year={2024}
137
  }
138
- ```
 
8
  - 1K<n<10K
9
  ---
10
  # COMMAND Dataset πŸ˜ƒ
11
+
12
+ ## πŸ€— Dataset Availability
13
+
14
+ The **evaluation data** from this dataset is now available on Hugging Face:
15
+ - **Repository**: [maum-ai/COMMAND](https://huggingface.co/datasets/maum-ai/COMMAND)
16
+ - **Content**: 60 evaluation scenarios (240 files, ~38GB)
17
+ - **File Types**: ROS bagfiles (`.bag`), metadata (`.json`), instructions (`.npy`), visualizations (`.png`)
18
+ - **Purpose**: Standardized evaluation set for benchmarking navigation models
19
+ - **Upload Date**: September 25, 2025
20
+ - **Status**: βœ… Successfully uploaded and verified
21
+
22
  ## Dataset Structure πŸ—‚οΈ
23
 
24
  The **COMMAND_dataset** is organized as follows:
 
34
  β”‚ └─ .yml # Map info (for ROS map server)
35
  β”œβ”€ bagfiles/ # Directory containing ROS bagfiles πŸŽ₯
36
  β”‚ └─ .bag # ROS bagfile with unique identifier
37
+ β”œβ”€ scenarios/ # Directory containing scenario information πŸ“œ
38
+ β”‚ β”œβ”€.json # Scenario schema
39
+ β”‚ └─.npy # Sketch instructions
40
+ └─ eval/ # Directory containing evaluation scenarios πŸ§ͺ
41
+ β”œβ”€.bag # ROS bagfile for evaluation
42
+ β”œβ”€.json # Evaluation scenario schema
43
+ β”œβ”€.npy # Evaluation sketch instructions
44
+ └─.png # Evaluation scenario visualization
45
  ```
46
 
47
  How to extract the dataset:
 
66
  | Avg. FD (P / M) | 1.05 / 1.77 | 0.97 / 2.02 | 3.03 / 3.50 | 1.91 / 3.76 |
67
  | % of Misleading | 31% | 51% | 50% | 39% |
68
 
69
+ **Training Data:** 3,317 bagfiles, includes 48 hours of driving data over 219 kilometers.
70
+ **Evaluation Data:** 60 bagfiles for standardized model evaluation.
71
+
72
+ **Total:** 3,377 bagfiles in the complete dataset.
73
 
74
+ **Note:** Training data values differ slightly from the paper because the data version history is missing.
75
 
76
  ## Directory Details πŸ—οΈ
77
 
 
88
  - **`<uuid>.json`**: Scenario schema file describing the scenario.
89
  - **`<uuid>.npy`**: Scenario annotations (sketch instructions). It contains a list of `(y, x)` pixel coordinates on the corresponding `sketch_map_name` map image.
90
 
91
+ ### `eval/`
92
+ - **`<uuid>.bag`**: ROS bagfile containing expert demonstration data for the evaluation scenario with robot sensor readings and control commands.
93
+ - **`<uuid>.json`**: Evaluation scenario schema file with the same structure as training scenarios but specifically designed for model evaluation.
94
+ - **`<uuid>.npy`**: Evaluation sketch instructions containing `(y, x)` pixel coordinates on the corresponding map image.
95
+ - **`<uuid>.png`**: Visualization image of the evaluation scenario showing the trajectory and environment.
96
+
97
+ **Evaluation Statistics:**
98
+ - **Total scenarios**: 60 evaluation scenarios (10 scenarios per each of the five environments + unseen environment Art museum (sim_art_museum))
99
+ - **File types**: 4 files per scenario (`.bag`, `.json`, `.npy`, `.png`)
100
+ - **Purpose**: Standardized evaluation set for benchmarking navigation models trained on the COMMAND dataset
101
+
102
  ---
103
 
104
  ### Topics in ROS Bagfiles πŸŽ₯
 
120
 
121
  5. **`/odom`**
122
  - **Message Type**: `nav_msgs/msg/Odometry`
123
+ - **Description**: Offers an estimate of the robot's position and velocity in free space. This serves as ground-truth data in simulation.
124
 
125
  6. **`/rgb_front/camera_info`, `/rgb_left/camera_info`, `/rgb_right/camera_info`**
126
  - **Message Type**: `sensor_msgs/msg/CameraInfo`
 
134
  - **Message Type**: `tf2_msgs/msg/TFMessage`
135
  - **Description**: Provides an odom-to-base_link transform.
136
 
137
+ ### Schema of Scenario JSON οΏ½οΏ½
138
+ Both training scenarios (in `scenarios/`) and evaluation scenarios (in `eval/`) follow the same JSON schema:
139
+
140
  - **`semantic_uuid`**: A unique identifier for the scenario. Combines map name, scenario name, and either "precise" or "misleading," followed by the scenario number.
141
  - **`map_name`**: The name of the map where the scenario is located.
142
  - **`sketch_map_name`**: The map where the sketch instructions are provided.
 
167
  journal={arXiv preprint arXiv:2410.01273},
168
  year={2024}
169
  }
170
+ ```