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

feat(learned_model): create package #6395

Merged
merged 104 commits into from
Apr 24, 2024

Conversation

atomyks
Copy link
Contributor

@atomyks atomyks commented Feb 13, 2024

Description

This PR creates a new package that enables running trained python vehicle models in the simple_planning_simulator. The main purpose of this PR is to have an easy way of launching python trained ML models in the simulator without a need for an extensive C++ code.

Related links

PyBind11
COMPANY INTERNAL LINK - How to properly launch this PR to test it

Tests performed

I tested this feature by using different python models, using different launch parameters while simulating the motion of the vehicle in the simulator.

Notes for reviewers

I created a tutorial on how to launch some basic trained python models. (see links)

There can be an issue with dependencies that I haven't been able to resolve yet. This feature depends on the python3 and pybind11 which probably cannot be installed using rosdep.

Interface changes

This PR changes the interface of simple_planning_simulator slightly by adding a few more launch parameters (more on this in the updated documentation). However, this PR does not remove any functionality of simple_planning_simulator and does not break the interface.

Effects on system behavior

This PR adds a new model to simple_planning_simulator. This PR does not break the existing code of simple_planning_simulator.

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.

  • The PR follows the pull request guidelines.
  • The PR has been properly tested.
  • The PR has been reviewed by the code owners.

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.
  • The PR is ready for merge.

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

Sorry, something went wrong.

@maxime-clem maxime-clem added the run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Feb 20, 2024
@atomyks atomyks requested a review from maxime-clem March 4, 2024 17:44
Copy link
Contributor

@maxime-clem maxime-clem left a comment

Choose a reason for hiding this comment

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

Please finish addressing all the comments and add copyrights to all the new files.
You should also make sure all the required checks are passing. For example https://results.pre-commit.ci/run/github/429651616/1709574266.1edMl4owQtGa-5vXW0GnQg

@maxime-clem maxime-clem added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Mar 11, 2024
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

Attention: Patch coverage is 0.65789% with 151 lines in your changes are missing coverage. Please review.

Project coverage is 14.79%. Comparing base (7d26879) to head (48379dc).
Report is 2 commits behind head on main.

Files Patch % Lines
...g_based_vehicle_model/src/interconnected_model.cpp 0.00% 55 Missing ⚠️
...earning_based_vehicle_model/src/simple_pymodel.cpp 0.00% 38 Missing ⚠️
...ator/vehicle_model/sim_model_learned_steer_vel.cpp 0.00% 33 Missing ⚠️
...ed_vehicle_model/src/model_connections_helpers.cpp 0.00% 14 Missing ⚠️
...nning_simulator/simple_planning_simulator_core.cpp 11.11% 4 Missing and 4 partials ⚠️
...ator/vehicle_model/sim_model_learned_steer_vel.hpp 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6395      +/-   ##
==========================================
- Coverage   14.93%   14.79%   -0.15%     
==========================================
  Files        1944     1929      -15     
  Lines      134033   132392    -1641     
  Branches    39871    39467     -404     
==========================================
- Hits        20023    19583     -440     
+ Misses      91718    90908     -810     
+ Partials    22292    21901     -391     
Flag Coverage Δ *Carryforward flag
differential 41.67% <0.65%> (?)
total 14.80% <ø> (-0.14%) ⬇️ Carriedforward from 819ef58

*This pull request uses carry forward flags. Click here to find out more.

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

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Copy link
Contributor

@TakaHoribe TakaHoribe left a comment

Choose a reason for hiding this comment

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

LGTM

@maxime-clem maxime-clem merged commit 41bee43 into autowarefoundation:main Apr 24, 2024
29 of 33 checks passed
karishma1911 pushed a commit to Interplai/autoware.universe that referenced this pull request Jun 3, 2024
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Co-authored-by: Tomas Nagy <tomas@pmc.sk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:simulation Virtual environment setups and simulations. (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.

None yet

3 participants