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

[WIP] Create documentation for NN support with TFLM #3617

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

SindreMHegre
Copy link

@SindreMHegre SindreMHegre commented Mar 4, 2025

This is documentation for the Neural network support for PX4 PR, which can be found here:

@SindreMHegre SindreMHegre force-pushed the neural_control_with_tflm_docs branch from 790c55c to 99aba8d Compare March 4, 2025 13:50
@@ -0,0 +1,19 @@
# NeuralControl (UORB message)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please remove this from here and the SUMMARY.md. The docs will be automatically pushed when the source comes in, and having it here now will create a clash later.

@@ -609,6 +609,7 @@
- [MountOrientation](msg_docs/MountOrientation.md)
- [NavigatorMissionItem](msg_docs/NavigatorMissionItem.md)
- [NavigatorStatus](msg_docs/NavigatorStatus.md)
- [NeuralControl](msg_docs/NeuralControl.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

@hamishwillee hamishwillee changed the title Create documentation for NN support with TFLM [WIP] Create documentation for NN support with TFLM Mar 5, 2025
Copy link

github-actions bot commented Mar 5, 2025

No flaws found

@hamishwillee hamishwillee marked this pull request as draft March 5, 2025 00:24
:::

## Custom Flight Mode
The module creates its own flight mode "Neural Control" which lets you choose it from the flight mode menu in QGC and bind it to a switch on you RC controller. This is done by using the [ROS 2 Interface Library](../ros2/px4_ros2_interface_lib.md) internally. This involves several steps:
Copy link
Collaborator

Choose a reason for hiding this comment

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

When you say ROS 2 interface library - do you actually run ROS? Or do you mean that this is handled by the mavlink standard modes protocol (i.e. the internal API that the interface library uses).

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@SindreMHegre Please move this out of draft when you are ready for review and I'll give it a look.

Please run prettier before you do that.

You might want to consider providing a concrete/worked example of how to use this. I.e. something practical so that people can see the benefits and copy the approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants