Skip to content

Commit 8d0c4e1

Browse files
docs(diffusion_planner): fix README.md (autowarefoundation#12067)
* Fixed README.md Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Deleted the change of `launch_traffic_light_module` Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp> --------- Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent b3b83b6 commit 8d0c4e1

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

planning/autoware_diffusion_planner/README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,20 @@ It is implemented as a ROS 2 component node, making it easy to integrate into Au
1818

1919
## How to use
2020

21-
Currently, some launch files must be changed to run the planning simulator with `autoware_diffusion_planner`.
21+
### (1) Prerequisites
22+
23+
Make sure that the directory specified in `planning/autoware_diffusion_planner/config/diffusion_planner.param.yaml` points to the correct model version and contains the required model weight and parameter files.
2224

23-
(1) `/path/to/src/launcher/autoware_launch`
25+
```bash
26+
$ ls ~/autoware_data/diffusion_planner/v3.0/
27+
diffusion_planner.onnx diffusion_planner.param.json
28+
```
29+
30+
This can be downloaded from [setup-dev-env.sh](https://github.com/autowarefoundation/autoware/blob/main/setup-dev-env.sh).
31+
32+
### (2) Modify launch files
33+
34+
Currently, some launch files must be changed to run the planning simulator with `autoware_diffusion_planner`.
2435

2536
```diff
2637
diff --git a/autoware_launch/config/control/trajectory_follower/longitudinal/pid.param.yaml b/autoware_launch/config/control/trajectory_follower/longitudinal/pid.param.yaml
@@ -35,6 +46,17 @@ diff --git a/autoware_launch/config/control/trajectory_follower/longitudinal/pid
3546

3647
# state transition
3748
drive_state_stop_dist: 0.5
49+
diff --git a/autoware_launch/config/planning/scenario_planning/common/common.param.yaml b/autoware_launch/config/planning/scenario_planning/common/common.param.yaml
50+
--- a/autoware_launch/config/planning/scenario_planning/common/common.param.yaml
51+
+++ b/autoware_launch/config/planning/scenario_planning/common/common.param.yaml
52+
@@ -1,6 +1,6 @@
53+
/**:
54+
ros__parameters:
55+
- max_vel: 4.17 # max velocity limit [m/s]
56+
+ max_vel: 22.2 # max velocity limit [m/s]
57+
58+
# constraints param for normal driving
59+
normal:
3860
diff --git a/autoware_launch/config/system/diagnostics/planning.yaml b/autoware_launch/config/system/diagnostics/planning.yaml
3961
--- a/autoware_launch/config/system/diagnostics/planning.yaml
4062
+++ b/autoware_launch/config/system/diagnostics/planning.yaml
@@ -59,15 +81,10 @@ diff --git a/autoware_launch/config/system/diagnostics/planning.yaml b/autoware_
5981

6082
- path: /autoware/planning/routing/state
6183
type: diag
62-
```
63-
64-
(2) `/path/to/autoware/src/universe/autoware_universe`
65-
66-
```diff
67-
diff --git a/launch/tier4_planning_launch/launch/planning.launch.xml b/launch/tier4_planning_launch/launch/planning.launch.xml
68-
--- a/launch/tier4_planning_launch/launch/planning.launch.xml
69-
+++ b/launch/tier4_planning_launch/launch/planning.launch.xml
70-
@@ -40,12 +40,34 @@
84+
diff --git a/tier4_universe_launch/tier4_planning_launch/launch/planning.launch.xml b/tier4_universe_launch/tier4_planning_launch/launch/planning.launch.xml
85+
--- a/tier4_universe_launch/tier4_planning_launch/launch/planning.launch.xml
86+
+++ b/tier4_universe_launch/tier4_planning_launch/launch/planning.launch.xml
87+
@@ -47,12 +47,34 @@
7188
</include>
7289
</group>
7390

@@ -102,9 +119,9 @@ diff --git a/launch/tier4_planning_launch/launch/planning.launch.xml b/launch/ti
102119
<arg name="input_objects_topic_name" value="$(var input_objects_topic_name)"/>
103120
<arg name="input_pointcloud_topic_name" value="$(var input_pointcloud_topic_name)"/>
104121
<arg name="planning_validator_param_path" value="$(var planning_validator_param_path)"/>
105-
diff --git a/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml b/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml
106-
--- a/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml
107-
+++ b/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml
122+
diff --git a/tier4_universe_launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning_deprecated.launch.xml b/tier4_universe_launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning_deprecated.launch.xml
123+
--- a/tier4_universe_launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning_deprecated.launch.xml
124+
+++ b/tier4_universe_launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning_deprecated.launch.xml
108125
@@ -240,7 +240,7 @@
109126
<remap from="~/input/accel" to="/localization/acceleration"/>
110127
<remap from="~/input/scenario" to="/planning/scenario_planning/scenario"/>
@@ -116,7 +133,7 @@ diff --git a/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/
116133
<remap from="~/output/stop_reasons" to="/planning/scenario_planning/status/stop_reasons"/>
117134
```
118135

119-
(3) launch the planning simulator
136+
### (3) Launch the planning simulator
120137

121138
```bash
122139
ros2 launch autoware_launch planning_simulator.launch.xml \
@@ -125,15 +142,6 @@ ros2 launch autoware_launch planning_simulator.launch.xml \
125142
sensor_model:=sample_sensor_kit
126143
```
127144

128-
Note: Make sure the appropriate version weight is set for the path specified in `planning/autoware_diffusion_planner/config/diffusion_planner.param.yaml`.
129-
130-
```bash
131-
$ ls ~/autoware_data/diffusion_planner/v2.0/
132-
diffusion_planner.onnx diffusion_planner.param.json
133-
```
134-
135-
This can be downloaded from [setup-dev-env.sh](https://github.com/autowarefoundation/autoware/blob/main/setup-dev-env.sh).
136-
137145
## Features
138146

139147
- **Diffusion-based trajectory generation** for flexible and robust planning

0 commit comments

Comments
 (0)