PurpleSand
commited on
Commit
β’
8de4771
1
Parent(s):
cad8b7d
Update README.md
Browse files
README.md
CHANGED
@@ -1,34 +1,26 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
language:
|
4 |
-
- en
|
5 |
-
---
|
6 |
-
# COMMAND Dataset
|
7 |
-
|
8 |
-
This is the README for the **COMMAND** dataset.
|
9 |
-
|
10 |
-
## Dataset Structure
|
11 |
|
12 |
The **COMMAND_dataset** is organized as follows:
|
13 |
-
|
14 |
COMMAND_dataset/
|
15 |
ββ README.md # Documentation for the dataset
|
16 |
-
ββ map_asset/ # Directory containing map assets
|
17 |
β ββ map_list.yml # Information of all maps
|
18 |
β ββ maps/ # Folder containing individual maps
|
19 |
β ββ <map_name>/ # Folder for a specific map
|
20 |
β ββ .png # Image representation of the map
|
21 |
β ββ .yml # Map info (for ROS map server)
|
22 |
-
ββ bagfiles/ # Directory containing ROS bagfiles
|
23 |
β ββ .bag # ROS bagfile with unique identifier
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
```
|
28 |
|
29 |
---
|
30 |
|
31 |
-
## Dataset Overview
|
|
|
32 |
### Statistics
|
33 |
|
34 |
| Environment | Office (sim_office) | Street (Road) (sim_street_road) | Street (Sidewalk) (sim_street_sidewalk) | Orchard (sim_orchard) |
|
@@ -41,28 +33,24 @@ COMMAND_dataset/
|
|
41 |
|
42 |
**Note:** These values differ slightly from the paper because the data version history is missing.
|
43 |
|
44 |
-
## Directory Details
|
45 |
|
46 |
### `map_asset/`
|
47 |
-
|
48 |
- **`map_list.yml`**: Contains metadata about all maps in the dataset.
|
49 |
- **`maps/`**: Holds individual map folders. Each folder typically includes:
|
50 |
- **`.png`**: An image representation of the map.
|
51 |
- **`.yml`**: Detailed map information (compatible with the [ROS map server](http://wiki.ros.org/map_server)).
|
52 |
|
53 |
### `bagfiles/`
|
54 |
-
|
55 |
- Contains ROS bagfiles, each identified by a unique UUID (e.g., **`<uuid>.bag`**).
|
56 |
|
57 |
-
|
58 |
### `scenarios/`
|
59 |
-
|
60 |
- **`<uuid>.json`**: Scenario schema file describing the scenario.
|
61 |
-
- **`<uuid>.npy`**: Scenario annotations(sketch instructions). It contains a list of (y, x) pixel coordinates on the corresponding `sketch_map_name` map image.
|
62 |
|
63 |
---
|
64 |
|
65 |
-
### Topics in ROS Bagfiles
|
66 |
1. **`/clock`**
|
67 |
- **Message Type**: `rosgraph_msgs/msg/Clock`
|
68 |
- **Description**: Publishes the current simulated time in a ROS system. Useful for synchronizing sensor data and events in simulation.
|
@@ -73,7 +61,7 @@ COMMAND_dataset/
|
|
73 |
|
74 |
3. **`/imu`**
|
75 |
- **Message Type**: `sensor_msgs/msg/Imu`
|
76 |
-
- **Description**: Provides data from an Inertial Measurement Unit, including orientation (as a quaternion), angular velocity
|
77 |
|
78 |
4. **`/joy`**
|
79 |
- **Message Type**: `sensor_msgs/msg/Joy`
|
@@ -81,7 +69,7 @@ COMMAND_dataset/
|
|
81 |
|
82 |
5. **`/odom`**
|
83 |
- **Message Type**: `nav_msgs/msg/Odometry`
|
84 |
-
- **Description**: Offers an estimate of the robotβs position and velocity in free space.
|
85 |
|
86 |
6. **`/rgb_front/camera_info`, `/rgb_left/camera_info`, `/rgb_right/camera_info`**
|
87 |
- **Message Type**: `sensor_msgs/msg/CameraInfo`
|
@@ -93,19 +81,18 @@ COMMAND_dataset/
|
|
93 |
|
94 |
8. **`/tf`**
|
95 |
- **Message Type**: `tf2_msgs/msg/TFMessage`
|
96 |
-
- **Description**: Provides
|
97 |
|
98 |
-
### Schema of Scenario JSON
|
99 |
-
- **`semantic_uuid`**: A unique identifier for the scenario.
|
100 |
- **`map_name`**: The name of the map where the scenario is located.
|
101 |
-
- **`sketch_map_name`**: The
|
102 |
-
- **`start`**: The starting point of the robot
|
103 |
- **`end`**: The ending point of the robot, predefined in annotated maps.
|
104 |
-
- **`drive_map_name`**: The
|
105 |
-
- **`model_guideline`**: Instructions for the robot to follow during the scenario
|
106 |
-
|
107 |
-
Example
|
108 |
|
|
|
109 |
```json
|
110 |
{
|
111 |
"semantic_uuid": "sim_office/coffee_delivery/precise/3/42",
|
@@ -116,7 +103,7 @@ Example
|
|
116 |
"drive_map_name": "occupancy_map",
|
117 |
"model_guideline": "You are an indoor food-serving robot.\n\nYou must follow these driving instructions:\n1. You must avoid collisions.\n2. You should prioritize reaching the final destination.\n3. You should follow the Trajectory Instruction.\n a. If the Trajectory Instruction cannot be followed due to any obstacles, you should deviate to bypass the obstacle.\n b. You should try to evade any identifiable obstacles.\n4. You should maintain a constant driving speed."
|
118 |
}
|
119 |
-
|
120 |
|
121 |
---
|
122 |
license: cc-by-nc-4.0
|
|
|
1 |
+
# COMMAND Dataset π
|
2 |
+
## Dataset Structure ποΈ
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3 |
|
4 |
The **COMMAND_dataset** is organized as follows:
|
5 |
+
|
6 |
COMMAND_dataset/
|
7 |
ββ README.md # Documentation for the dataset
|
8 |
+
ββ map_asset/ # Directory containing map assets πΊοΈ
|
9 |
β ββ map_list.yml # Information of all maps
|
10 |
β ββ maps/ # Folder containing individual maps
|
11 |
β ββ <map_name>/ # Folder for a specific map
|
12 |
β ββ .png # Image representation of the map
|
13 |
β ββ .yml # Map info (for ROS map server)
|
14 |
+
ββ bagfiles/ # Directory containing ROS bagfiles π₯
|
15 |
β ββ .bag # ROS bagfile with unique identifier
|
16 |
+
ββ scenarios/ # Directory containing scenario information π
|
17 |
+
ββ.json # Scenario schema
|
18 |
+
ββ.npy # Sketch instructions
|
|
|
19 |
|
20 |
---
|
21 |
|
22 |
+
## Dataset Overview π
|
23 |
+
|
24 |
### Statistics
|
25 |
|
26 |
| Environment | Office (sim_office) | Street (Road) (sim_street_road) | Street (Sidewalk) (sim_street_sidewalk) | Orchard (sim_orchard) |
|
|
|
33 |
|
34 |
**Note:** These values differ slightly from the paper because the data version history is missing.
|
35 |
|
36 |
+
## Directory Details ποΈ
|
37 |
|
38 |
### `map_asset/`
|
|
|
39 |
- **`map_list.yml`**: Contains metadata about all maps in the dataset.
|
40 |
- **`maps/`**: Holds individual map folders. Each folder typically includes:
|
41 |
- **`.png`**: An image representation of the map.
|
42 |
- **`.yml`**: Detailed map information (compatible with the [ROS map server](http://wiki.ros.org/map_server)).
|
43 |
|
44 |
### `bagfiles/`
|
|
|
45 |
- Contains ROS bagfiles, each identified by a unique UUID (e.g., **`<uuid>.bag`**).
|
46 |
|
|
|
47 |
### `scenarios/`
|
|
|
48 |
- **`<uuid>.json`**: Scenario schema file describing the scenario.
|
49 |
+
- **`<uuid>.npy`**: Scenario annotations (sketch instructions). It contains a list of `(y, x)` pixel coordinates on the corresponding `sketch_map_name` map image.
|
50 |
|
51 |
---
|
52 |
|
53 |
+
### Topics in ROS Bagfiles π₯
|
54 |
1. **`/clock`**
|
55 |
- **Message Type**: `rosgraph_msgs/msg/Clock`
|
56 |
- **Description**: Publishes the current simulated time in a ROS system. Useful for synchronizing sensor data and events in simulation.
|
|
|
61 |
|
62 |
3. **`/imu`**
|
63 |
- **Message Type**: `sensor_msgs/msg/Imu`
|
64 |
+
- **Description**: Provides data from an Inertial Measurement Unit, including orientation (as a quaternion), angular velocity, and linear acceleration.
|
65 |
|
66 |
4. **`/joy`**
|
67 |
- **Message Type**: `sensor_msgs/msg/Joy`
|
|
|
69 |
|
70 |
5. **`/odom`**
|
71 |
- **Message Type**: `nav_msgs/msg/Odometry`
|
72 |
+
- **Description**: Offers an estimate of the robotβs position and velocity in free space. This serves as ground-truth data in simulation.
|
73 |
|
74 |
6. **`/rgb_front/camera_info`, `/rgb_left/camera_info`, `/rgb_right/camera_info`**
|
75 |
- **Message Type**: `sensor_msgs/msg/CameraInfo`
|
|
|
81 |
|
82 |
8. **`/tf`**
|
83 |
- **Message Type**: `tf2_msgs/msg/TFMessage`
|
84 |
+
- **Description**: Provides an odom-to-base_link transform.
|
85 |
|
86 |
+
### Schema of Scenario JSON π
|
87 |
+
- **`semantic_uuid`**: A unique identifier for the scenario. Combines map name, scenario name, and either "precise" or "misleading," followed by the scenario number.
|
88 |
- **`map_name`**: The name of the map where the scenario is located.
|
89 |
+
- **`sketch_map_name`**: The map where the sketch instructions are provided.
|
90 |
+
- **`start`**: The starting point of the robot (can be a specific point or "random").
|
91 |
- **`end`**: The ending point of the robot, predefined in annotated maps.
|
92 |
+
- **`drive_map_name`**: The map that the robot uses for navigation, usually an occupancy map.
|
93 |
+
- **`model_guideline`**: Instructions for the robot to follow during the scenario, serving as input for model training.
|
|
|
|
|
94 |
|
95 |
+
**Example:**
|
96 |
```json
|
97 |
{
|
98 |
"semantic_uuid": "sim_office/coffee_delivery/precise/3/42",
|
|
|
103 |
"drive_map_name": "occupancy_map",
|
104 |
"model_guideline": "You are an indoor food-serving robot.\n\nYou must follow these driving instructions:\n1. You must avoid collisions.\n2. You should prioritize reaching the final destination.\n3. You should follow the Trajectory Instruction.\n a. If the Trajectory Instruction cannot be followed due to any obstacles, you should deviate to bypass the obstacle.\n b. You should try to evade any identifiable obstacles.\n4. You should maintain a constant driving speed."
|
105 |
}
|
106 |
+
|
107 |
|
108 |
---
|
109 |
license: cc-by-nc-4.0
|