# memetsumer/airsim-uav-sar-yolov5 architecture

> Architecture diagram of the GitHub repository memetsumer/airsim-uav-sar-yolov5, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/memetsumer/airsim-uav-sar-yolov5
- Repository: https://github.com/memetsumer/airsim-uav-sar-yolov5

## Overview

##### Project type and purpose
- This is a research-oriented simulation pipeline rather than a production service‐oriented application.
- Purpose: run an autonomous UAV in the AirSim simulator, capture imagery, and perform Search‐And‐Rescue (SAR) object detection using different YOLOv5 model variants (nano, small, medium).

##### File structure
- Top‐level files:
- LICENSE (project license)
- README.md (project description)
- Three Jupyter notebooks, one per YOLOv5 variant:
– YOLOv5n_AirSim_SAR_UAV_17_05_2022.ipynb
– YOLOv5s_AirSim_SAR_UAV_17_05_2022.ipynb
– YOLOv5m_AirSim_SAR_UAV_17_05_2022.ipynb

##### Readme insights
- Confirms the workflow: AirSim provides simulated UAV flight and camera feed; YOLOv5 models run on that stream; predictions are logged for analysis.

##### Components
a. Main components
1. AirSim Simulator
2. UAV Agent (PX4 or built-in AirSim drone API)
3. Camera/Sensor Module (virtual RGB/Depth/LiDAR)
4. Inference Engine (YOLOv5 variants)
5. Prediction Logger (predictions_yolov5 directory)
b. Relationships and interactions
– Control flow:
AirSim Simulator → UAV Agent → captures frames
Frames → Inference Engine → produces detection results
Results → Prediction Logger → stored artifacts
c. Architectural patterns / design principles
– Pipeline architecture: modular data acquisition, modular inference, modular logging
– Experiment-driven: interchangeable model components (n, s, m)
– Clear separation of concerns: simulation vs. perception vs. logging
d. Relevant technologies / libraries
– AirSim (Microsoft AirSim Python/C++ API)
– YOLOv5 (PyTorch‐based detection code)
– Jupyter Notebooks for orchestration and visualization
– Python logging/File I/O for predictions
– (If used) camera API, NumPy/OpenCV for frame handling

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Simulation Layer"
        Setup["Project Setup & Dependencies"]:::meta
        AirSim["AirSim Simulator"]:::sim
        UAV["UAV Agent\n(PX4/AirSim API)"]:::sim
        Sensor["Camera/Sensor Module"]:::sim
    end

    subgraph "Inference Layer"
        direction TB
        YOLOn["YOLOv5 Nano\nInference Engine"]:::infer
        YOLOs["YOLOv5 Small\nInference Engine"]:::infer
        YOLOm["YOLOv5 Medium\nInference Engine"]:::infer
    end

    Logger["Prediction Logger\n(predictions_yolov5)"]:::storage
    Viz["Visualization &\nPost-processing"]:::viz

    Setup --> AirSim --> UAV --> Sensor --> YOLOn
    Sensor --> YOLOs
    Sensor --> YOLOm
    YOLOn --> Logger
    YOLOs --> Logger
    YOLOm --> Logger
    Logger -.-> Viz

    License["Project License"]:::meta
    License -.-> Setup

    click Setup "https://github.com/memetsumer/airsim-uav-sar-yolov5/blob/main/README.md"
    click YOLOn "https://github.com/memetsumer/airsim-uav-sar-yolov5/blob/main/YOLOv5n_AirSim_SAR_UAV_17_05_2022.ipynb"
    click YOLOs "https://github.com/memetsumer/airsim-uav-sar-yolov5/blob/main/YOLOv5s_AirSim_SAR_UAV_17_05_2022.ipynb"
    click YOLOm "https://github.com/memetsumer/airsim-uav-sar-yolov5/blob/main/YOLOv5m_AirSim_SAR_UAV_17_05_2022.ipynb"
    click Logger "https://github.com/memetsumer/airsim-uav-sar-yolov5/tree/main/predictions_yolov5m/"
    click License "https://github.com/memetsumer/airsim-uav-sar-yolov5/tree/main/LICENSE"

    classDef sim fill:#AEDFF7,stroke:#0B5FA5,color:#000;
    classDef infer fill:#C6F6D5,stroke:#2F855A,color:#000;
    classDef storage fill:#FEEBC8,stroke:#DD6B20,color:#000;
    classDef viz fill:#E9D8FD,stroke:#805AD5,color:#000,stroke-dasharray: 5 5;
    classDef meta fill:#EDF2F7,stroke:#A0AEC0,color:#000;
```
