Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(behavior_path_planner): update main documentation #5519

Conversation

zulfaqar-azmi-t4
Copy link
Contributor

Description

Update behavior path planner's documentation

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) labels Nov 8, 2023
@zulfaqar-azmi-t4 zulfaqar-azmi-t4 removed the component:planning Route planning, decision-making, and navigation. (auto-assigned) label Nov 8, 2023
@github-actions github-actions bot added the component:planning Route planning, decision-making, and navigation. (auto-assigned) label Nov 8, 2023
@zulfaqar-azmi-t4 zulfaqar-azmi-t4 self-assigned this Nov 8, 2023
@zulfaqar-azmi-t4 zulfaqar-azmi-t4 force-pushed the doc-behavior-path-planner branch from e77456d to 558c97b Compare November 8, 2023 06:46
@zulfaqar-azmi-t4 zulfaqar-azmi-t4 added the run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Nov 8, 2023

-
1. Some module cannot be simultaneously executed for now. For instance
- Avoidance and Goal planner
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Avoidance and Goal planner
- Goal Planner (when Pull Over) and other modules (Avoidance, Lane Change, Start Planner)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zulfaqar-azmi-t4 zulfaqar-azmi-t4 force-pushed the doc-behavior-path-planner branch from 8472eea to b53fff9 Compare November 17, 2023 09:55
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Signed-off-by: Zulfaqar Azmi <[email protected]>
Copy link
Contributor

@satoshi-ota satoshi-ota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@zulfaqar-azmi-t4 zulfaqar-azmi-t4 added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Nov 22, 2023
Copy link

codecov bot commented Nov 22, 2023

Codecov Report

Attention: 185 lines in your changes are missing coverage. Please review.

Comparison is base (765a596) 15.32% compared to head (a599acc) 12.63%.
Report is 42 commits behind head on main.

Files Patch % Lines
.../scene_module/goal_planner/goal_planner_module.cpp 1.83% 106 Missing and 1 partial ⚠️
...er/src/scene_module/avoidance/avoidance_module.cpp 0.00% 31 Missing and 3 partials ⚠️
.../scene_module/goal_planner/goal_planner_module.hpp 15.78% 15 Missing and 1 partial ⚠️
...th_planner/src/scene_module/lane_change/normal.cpp 0.00% 11 Missing ⚠️
...e/behavior_path_planner/utils/avoidance/helper.hpp 0.00% 4 Missing ⚠️
...ath_planner/src/scene_module/avoidance/manager.cpp 0.00% 0 Missing and 4 partials ⚠️
...cene_module/start_planner/start_planner_module.cpp 0.00% 3 Missing ⚠️
...rivable_area_expansion/drivable_area_expansion.cpp 40.00% 0 Missing and 3 partials ⚠️
...h_planner/src/scene_module/lane_change/manager.cpp 0.00% 0 Missing and 2 partials ⚠️
...vior_path_planner/src/utils/start_planner/util.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #5519       +/-   ##
===========================================
- Coverage   15.32%   12.63%    -2.69%     
===========================================
  Files        1721      107     -1614     
  Lines      118559    14981   -103578     
  Branches    37995     8421    -29574     
===========================================
- Hits        18169     1893    -16276     
+ Misses      79657    10140    -69517     
+ Partials    20733     2948    -17785     
Flag Coverage Δ
differential 12.63% <3.64%> (?)
total ?

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zulfaqar-azmi-t4 zulfaqar-azmi-t4 merged commit b50be76 into autowarefoundation:main Nov 27, 2023
30 of 32 checks passed
@zulfaqar-azmi-t4 zulfaqar-azmi-t4 deleted the doc-behavior-path-planner branch November 27, 2023 02:45
danielsanchezaran pushed a commit to tier4/autoware.universe that referenced this pull request Dec 15, 2023
…ation#5519)

* docs(behavior_path_planner): update main documentation

Signed-off-by: Zulfaqar Azmi <[email protected]>

* place image in note

Signed-off-by: Zulfaqar Azmi <[email protected]>

* Add  path shifter explanation

Signed-off-by: Zulfaqar Azmi <[email protected]>

* Update input output and debug

Signed-off-by: Zulfaqar Azmi <[email protected]>

* fix introduction

Signed-off-by: Zulfaqar Azmi <[email protected]>

* enchance drivable area expansion explanation

Signed-off-by: Zulfaqar Azmi <[email protected]>

* fix type in the debug subsection

* include safety check

Signed-off-by: Zulfaqar Azmi <[email protected]>

* add parameter folder structure

Signed-off-by: Zulfaqar Azmi <[email protected]>

* Enabling and disabling module

Signed-off-by: Zulfaqar Azmi <[email protected]>

* fix limitation

Signed-off-by: Zulfaqar Azmi <[email protected]>

* Update based on feedback

Signed-off-by: Zulfaqar Azmi <[email protected]>

* Rerouting subsection

Signed-off-by: Zulfaqar Azmi <[email protected]>

* minor fixes

Signed-off-by: Zulfaqar Azmi <[email protected]>

* fix some minor point

Signed-off-by: Zulfaqar Azmi <[email protected]>

---------

Signed-off-by: Zulfaqar Azmi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:planning Route planning, decision-making, and navigation. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants