Skip to content

[RDI- 083]: Add AI HAT+ README.md - #7

Open
Jacque-nk wants to merge 15 commits into
mainfrom
feature/RDI-083-add-AI-HAT+-README.md
Open

[RDI- 083]: Add AI HAT+ README.md#7
Jacque-nk wants to merge 15 commits into
mainfrom
feature/RDI-083-add-AI-HAT+-README.md

Conversation

@Jacque-nk

Copy link
Copy Markdown
Contributor

What this PR Does

This PR adds a structured guide for setting up and benchmarking the Raspberry Pi AI HAT+ on a Raspberry Pi 5 running Ubuntu 24.04.

The documentation guides the user through the complete workflow:

  1. AI HAT+ hardware installation
  2. AI HAT+ software setup
  3. Hailo device verification
  4. ROS 2 image-to-detection benchmarking
  5. Benchmark results and analysis

The main README acts as a navigation guide and directs users to the detailed hardware, software, and benchmarking documentation.

Screenshots / logs (if applicable)

Supporting screenshots, setup images, benchmark outputs, and graphs are provided in the respective image folders:

  • Hardware_setup_images
  • Software_setup_images
  • Benchmarking_setup_images

These images are referenced by the corresponding README documentation.

Related Ticket

RDI-83

Changes Made

  • Added the main AI HAT+ setup and benchmarking README.
  • Organized the documentation into hardware setup, software setup, and benchmarking stages.
  • Added links between the three setup stages to guide users through the process in the correct order.
  • Documented that the benchmark measures the full ROS 2 image-to-detection pipeline rather than the Hailo-8L chip in isolation.
  • Added the benchmark workflow, results, interpretation, limitations, conclusion, and future work.
  • Added references to the supporting image folders for each documentation stage.
  • Organized the documentation structure to make the setup process easier to follow.

How to Test it

  • Open the AI HAT+ main README.
  • Follow the Hardware Setup link and verify that it points to the correct hardware README.
  • Follow the Software Setup link and verify that it points to the correct software README.
  • Follow the Benchmarking link and verify that it points to the correct benchmarking README.
  • Verify that the documented setup order is Hardware → Software → Verification → Benchmarking.
  • Verify that the benchmark is correctly described as a ROS 2 image-to-detection pipeline benchmark.
  • Verify that the benchmark results and limitations are clearly documented.
  • Verify that the referenced image folders contain the supporting screenshots and visual documentation.

Checklist

  • Documentation added/updated
  • Hardware setup procedure documented
  • Software setup procedure documented
  • Benchmarking procedure documented
  • Troubleshooting information included
  • Benchmark results documented
  • Limitations and future work documented
  • Screenshots/images organized in dedicated folders
  • Documentation links verified
  • Code changes required

RDI-083 - Added Hailo packages

@codewithlennylen codewithlennylen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check comments: let users download the packages from the official sources.

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