# opencv/ade architecture

> Architecture diagram of the GitHub repository opencv/ade, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/opencv/ade
- Repository: https://github.com/opencv/ade

## Overview

##### Main Components

a. Core Graph Components:
- Graph Management System (from sources/ade/include/ade/graph.hpp, typed_graph.hpp)
- Node Management (node.hpp)
- Edge Management (edge.hpp)
- Metadata System (typed_metadata.hpp)

b. Execution System:
- Execution Engine (execution_engine/execution_engine.hpp)
- Backend Interface (execution_engine/backend.hpp)
- Executable Interface (execution_engine/executable.hpp)

c. Memory Management:
- Memory Accessor System (memory/memory_accessor.hpp)
- Memory Descriptors (memory/memory_descriptor.hpp)
- Memory Access Listeners (memory/memory_access_listener.hpp)

d. Pass Management:
- Pass Manager (passmanager.hpp)
- Pass Implementation System (passes/pass_base.hpp)
- Standard Passes:
- Cycle Detection (passes/check_cycles.hpp)
- Communications (passes/communications.hpp)
- Topological Sort (passes/topological_sort.hpp)

**[Core Graph Layer]**
- ↑↓
**[Execution Layer]**
- ↑↓
**[Memory Management Layer]**
- ↑↓
**[Pass Management Layer]**

##### Important Relationships to Highlight

a. Graph Layer Relationships:
- Nodes ↔ Edges
- Graph ↔ Metadata
- Typed Graph inheritance from base Graph

b. Execution Flow:
- Execution Engine → Backend
- Backend → Executable
- Graph → Execution Engine

c. Memory Management:
- Memory Accessor → Memory Descriptors
- Memory Descriptors → Memory Access Listeners

d. Pass System:
- Pass Manager → Individual Passes
- Passes → Graph modifications

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style definitions
    classDef core fill:#b3d9ff,stroke:#333,stroke-width:2px
    classDef execution fill:#90EE90,stroke:#333,stroke-width:2px
    classDef memory fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef pass fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef utility fill:#D3D3D3,stroke:#333,stroke-width:2px
    classDef comm fill:#FFB6C1,stroke:#333,stroke-width:2px

    %% Core Graph Layer
    subgraph CoreLayer
        Graph["Graph Management"]
        TypedGraph["Typed Graph"]
        Node["Node Management"]
        Edge["Edge Management"]
        Metadata["Metadata System"]
    end

    %% Execution Layer
    subgraph ExecutionLayer
        ExecEngine["Execution Engine"]
        Backend["Backend Interface"]
        Executable["Executable Interface"]
    end

    %% Memory Management Layer
    subgraph MemoryLayer
        MemAccessor["Memory Accessor"]
        MemDesc["Memory Descriptors"]
        MemListener["Memory Access Listeners"]
    end

    %% Pass Management Layer
    subgraph PassLayer
        PassManager["Pass Manager"]
        PassBase["Pass Implementation"]
        CycleDetect["Cycle Detection"]
        CommPass["Communications Pass"]
        TopoSort["Topological Sort"]
    end

    %% Communication Components
    subgraph CommLayer
        CommInterface["Communication Interface"]
        CommBuffer["Communication Buffer"]
        CallbackConn["Callback Connector"]
    end

    %% Utility Components
    subgraph UtilLayer
        Assert["Assert System"]
        Search["Search Helpers"]
        Subgraphs["Subgraph Utilities"]
    end

    %% Relationships
    Graph --> TypedGraph
    Graph --> Node
    Graph --> Edge
    Graph --> Metadata
    ExecEngine --> Backend
    Backend --> Executable
    Graph --> ExecEngine
    MemAccessor --> MemDesc
    MemDesc --> MemListener
    PassManager --> PassBase
    PassBase --> CycleDetect
    PassBase --> CommPass
    PassBase --> TopoSort
    CommInterface --> CommBuffer
    CommBuffer --> CallbackConn

    %% Click events
    click Graph "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/graph.hpp"
    click TypedGraph "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/typed_graph.hpp"
    click Node "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/node.hpp"
    click Edge "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/edge.hpp"
    click Metadata "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/typed_metadata.hpp"
    click ExecEngine "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/execution_engine/execution_engine.hpp"
    click Backend "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/execution_engine/backend.hpp"
    click Executable "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/execution_engine/executable.hpp"
    click MemAccessor "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/memory/memory_accessor.hpp"
    click MemDesc "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/memory/memory_descriptor.hpp"
    click MemListener "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/memory/memory_access_listener.hpp"
    click PassManager "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/passmanager.hpp"
    click PassBase "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/passes/pass_base.hpp"
    click CycleDetect "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/passes/check_cycles.hpp"
    click CommPass "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/passes/communications.hpp"
    click TopoSort "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/passes/topological_sort.hpp"
    click CommInterface "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/communication/comm_interface.hpp"
    click CommBuffer "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/communication/comm_buffer.hpp"
    click CallbackConn "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/communication/callback_connector.hpp"
    click Assert "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/util/assert.hpp"
    click Search "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/helpers/search.hpp"
    click Subgraphs "https://github.com/opencv/ade/blob/master/sources/ade/include/ade/helpers/subgraphs.hpp"

    %% Style Applications
    class Graph,TypedGraph,Node,Edge,Metadata core
    class ExecEngine,Backend,Executable execution
    class MemAccessor,MemDesc,MemListener memory
    class PassManager,PassBase,CycleDetect,CommPass,TopoSort pass
    class Assert,Search,Subgraphs utility
    class CommInterface,CommBuffer,CallbackConn comm
```
