Skip to content

Commit 77c1a3f

Browse files
authored
fix(planning): corrects minor typos (#9809)
Signed-off-by: Atto Armoo <168620037+AA-T4@users.noreply.github.com>
1 parent 33b9913 commit 77c1a3f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

planning/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Enabling and disabling modules involves managing settings in key configuration a
1818

1919
### Key Files for Configuration
2020

21-
The `default_preset.yaml` file acts as the primary configuration file, where planning modules can be disable or enabled. Furthermore, users can also set the type of motion planner across various motion planners. For example:
21+
The `default_preset.yaml` file acts as the primary configuration file, where planning modules can be disabled or enabled. Furthermore, users can also set the type of motion planner across various motion planners. For example:
2222

2323
- `launch_avoidance_module`: Set to `true` to enable the avoidance module, or `false` to disable it.
2424
- `motion_stop_planner_type`: Set `default` to either `obstacle_stop_planner` or `obstacle_cruise_planner`.
@@ -35,23 +35,23 @@ The [launch files](https://github.com/autowarefoundation/autoware.universe/tree/
3535

3636
corresponds to launch_avoidance_module from `default_preset.yaml`.
3737

38-
### Parameters configuration
38+
### Parameter Configuration
3939

4040
There are multiple parameters available for configuration, and users have the option to modify them in [here](https://github.com/autowarefoundation/autoware_launch/tree/main/autoware_launch/config/planning). It's important to note that not all parameters are adjustable via `rqt_reconfigure`. To ensure the changes are effective, modify the parameters and then restart Autoware. Additionally, detailed information about each parameter is available in the corresponding documents under the planning tab.
4141

4242
### Integrating a Custom Module into Autoware: A Step-by-Step Guide
4343

4444
This guide outlines the steps for integrating your custom module into Autoware:
4545

46-
- Add your modules to the `default_preset.yaml` file. For example
46+
- Add your modules to the `default_preset.yaml` file. For example:
4747

4848
```yaml
4949
- arg:
5050
name: launch_intersection_module
5151
default: "true"
5252
```
5353
54-
- Incorporate your modules into the [launcher](https://github.com/autowarefoundation/autoware.universe/tree/main/launch/tier4_planning_launch/launch/scenario_planning). For example in [behavior_planning.launch.xml](https://github.com/autowarefoundation/autoware.universe/blob/main/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml):
54+
- Incorporate your modules into the [launcher](https://github.com/autowarefoundation/autoware.universe/tree/main/launch/tier4_planning_launch/launch/scenario_planning). For example, in [behavior_planning.launch.xml](https://github.com/autowarefoundation/autoware.universe/blob/main/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml):
5555
5656
```xml
5757
<arg name="launch_intersection_module" default="true"/>
@@ -63,14 +63,14 @@ This guide outlines the steps for integrating your custom module into Autoware:
6363
/>
6464
```
6565

66-
- If applicable, place your parameter folder within the appropriate existing parameter folder. For example [intersection_module's parameters](https://github.com/autowarefoundation/autoware_launch/blob/main/autoware_launch/config/planning/scenario_planning/lane_driving/behavior_planning/behavior_velocity_planner/intersection.param.yaml) is in [behavior_velocity_planner](https://github.com/autowarefoundation/autoware_launch/tree/main/autoware_launch/config/planning/scenario_planning/lane_driving/behavior_planning/behavior_velocity_planner).
67-
- Insert the path of your parameters in the [tier4_planning_component.launch.xml](https://github.com/autowarefoundation/autoware_launch/blob/main/autoware_launch/launch/components/tier4_planning_component.launch.xml). For example `behavior_velocity_planner_intersection_module_param_path` is used.
66+
- If applicable, place your parameter folder within the appropriate existing parameter folder. For example, [intersection_module's parameters](https://github.com/autowarefoundation/autoware_launch/blob/main/autoware_launch/config/planning/scenario_planning/lane_driving/behavior_planning/behavior_velocity_planner/intersection.param.yaml) are in [behavior_velocity_planner](https://github.com/autowarefoundation/autoware_launch/tree/main/autoware_launch/config/planning/scenario_planning/lane_driving/behavior_planning/behavior_velocity_planner).
67+
- Insert the path of your parameters in the [tier4_planning_component.launch.xml](https://github.com/autowarefoundation/autoware_launch/blob/main/autoware_launch/launch/components/tier4_planning_component.launch.xml). For example, `behavior_velocity_planner_intersection_module_param_path` is used.
6868

6969
```xml
7070
<arg name="behavior_velocity_planner_intersection_module_param_path" value="$(var behavior_velocity_config_path)/intersection.param.yaml"/>
7171
```
7272

73-
- Define your parameter path variable within the corresponding launcher. For example in [behavior_planning.launch.xml](https://github.com/autowarefoundation/autoware.universe/blob/04aa54bf5fb0c88e70198ca74b9ac343cc3457bf/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml#L191)
73+
- Define your parameter path variable within the corresponding launcher. For example, in [behavior_planning.launch.xml](https://github.com/autowarefoundation/autoware.universe/blob/04aa54bf5fb0c88e70198ca74b9ac343cc3457bf/launch/tier4_planning_launch/launch/scenario_planning/lane_driving/behavior_planning/behavior_planning.launch.xml#L191)
7474

7575
```xml
7676
<param from="$(var behavior_velocity_planner_intersection_module_param_path)"/>
@@ -82,7 +82,7 @@ This guide outlines the steps for integrating your custom module into Autoware:
8282

8383
## Join Our Community-Driven Effort
8484

85-
Autoware thrives on community collaboration. Every contribution, big or small, is invaluable to us. Whether it's reporting bugs, suggesting improvements, offering new ideas, or anything else you can think of – we welcome it all with open arms.
85+
Autoware thrives on community collaboration. Every contribution, big or small, is invaluable to us. Whether it's reporting bugs, suggesting improvements, offering new ideas, or anything else you can think of – we welcome all contributions with open arms.
8686

8787
### How to Contribute?
8888

@@ -105,7 +105,7 @@ Interested in joining our meetings? We’d love to have you! For more informatio
105105

106106
Occasionally, we publish papers specific to the Planning Component in Autoware. We encourage you to explore these publications and find valuable insights for your work. If you find them useful and incorporate any of our methodologies or algorithms in your projects, citing our papers would be immensely helpful. This support allows us to reach a broader audience and continue contributing to the field.
107107

108-
If you use the Jerk Constrained Velocity Planning algorithm in [Motion Velocity Smoother](./autoware_velocity_smoother/README.md) module in the Planning Component, we kindly request you to cite the relevant paper.
108+
If you use the Jerk Constrained Velocity Planning algorithm in the [Motion Velocity Smoother](./autoware_velocity_smoother/README.md) module in the Planning Component, we kindly request you cite the relevant paper.
109109

110110
<!-- cspell:ignore Shimizu, Horibe, Watanabe, Kato -->
111111

0 commit comments

Comments
 (0)