Skip to content

Commit

Permalink
updating docs for mppi_opt (ros-planning#533)
Browse files Browse the repository at this point in the history
* updating docs for mppi_opt

* adding to migration guide
  • Loading branch information
SteveMacenski committed Mar 22, 2024
1 parent a898137 commit cd6dad8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
25 changes: 24 additions & 1 deletion configuration/packages/configuring-mppic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,16 @@ This critic incentivizes navigating away from obstacles and critical collisions
Description
Name of the inflation layer. If empty, it uses the last inflation layer in the costmap. If you have multiple inflation layers, you may want to specify the name of the layer to use.

:trajectory_point_step:

============== ===========================
Type Default
-------------- ---------------------------
int 2
============== ===========================

Description
The step to take in trajectories for evaluating them in the critic. Since trajectories are extremely dense, its unnecessary to evaluate each point and computationally expensive.

Path Align Critic
-----------------
Expand Down Expand Up @@ -722,6 +732,18 @@ This critic incentivizes aligning with the global path, if relevant. It does not
Description
Whether to consider path's orientations in path alignment, which can be useful when paired with feasible smac planners to incentivize directional changes only where/when the smac planner requests them. If you want the robot to deviate and invert directions where the controller sees fit, keep as false. If your plans do not contain orientation information (e.g. navfn), keep as false.

:trajectory_point_step:

============== ===========================
Type Default
-------------- ---------------------------
int 4
============== ===========================

Description
The step to take in trajectories for evaluating them in the critic. Since trajectories are extremely dense, its unnecessary to evaluate each point and computationally expensive.


Path Angle Critic
-----------------

Expand Down Expand Up @@ -980,12 +1002,13 @@ Example
consider_footprint: true
collision_cost: 1000000.0
near_goal_distance: 1.0
trajectory_point_step: 2
PathAlignCritic:
enabled: true
cost_power: 1
cost_weight: 14.0
max_path_occupancy_ratio: 0.05
trajectory_point_step: 3
trajectory_point_step: 4
threshold_to_consider: 0.5
offset_from_furthest: 20
use_path_orientations: false
Expand Down
5 changes: 5 additions & 0 deletions migration/Iron.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ Analog to the ``ObstacleCritic``, the ``CostCritic`` is another obstacle avoidin
This critic uses the inflated costs in the costmap to score rather than distance to obstacles as the ``ObstaclesCritic`` does.
See the configuration guide for more information.

MPPI Acceleration
*****************

New to Jazzy, MPPI is 45% faster due to a weeks long optimization campaign. Enjoy!

Move Error Code Enumerations
****************************

Expand Down

0 comments on commit cd6dad8

Please sign in to comment.