# mervinpraison/praisonai architecture

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

- Interactive diagram: https://gitdiagram.com/mervinpraison/praisonai
- Repository: https://github.com/mervinpraison/praisonai

## Overview

##### High-Level Components

a) User Interface Layer
- Multiple UI options:
- Web UI (Multi-Agents Interface)
- Chat Interface
- Code Interface
- Realtime Voice Interface

b) Core Framework Layer
- Create three parallel tracks:
- PraisonAI Agents
- AutoGen Integration
- CrewAI Integration
- How they connect to the Agent Management System

c) Agent Management System
- Agent Creation & Configuration
- Task Management
- Process Orchestration
- Memory Management
- Self Reflection System

d) Tools & Integration Layer
- External Tools Integration
- Custom Tools Support
- Internet Search Capabilities
- Model Integration Layer

##### Key Relationships to Highlight

**User Interface Layer**
- ↕
**Core Framework Layer**
- ↕
**Agent Management System**
- ↕
**Tools & Integration Layer**

##### Detailed Component Breakdown

For each major component, include these subcomponents:

Agent Management System:
**┌─ Agent Management ─────┐**
- Agent Configuration │
- Role Definition     │
- Goal Setting       │
- Task Assignment    │
- ┘

Process Orchestration:
**┌─ Process Types ────────┐**
- Hierarchical        │
- Sequential          │
- Parallel           │
- ┘

##### Integration Points

Clear connection points for:
- LLM Providers (OpenAI, Ollama, Groq, etc.)
- External Tools (Crawl4AI, Tavily, etc.)
- Custom Tool Integration
- Database/Storage Systems

##### Special Features to Highlight

Create dedicated sections for:
- Self Reflection System
- Multi-Modal Capabilities
- Real-time Processing
- Memory Management

##### Data Flow Indicators

→ Synchronous Communication
⇢ Asynchronous Communication
⇄ Bidirectional Data Flow

##### Deployment Options

Deployment possibilities:
- Local Development
- Docker Containers
- Cloud Deployment

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef ui fill:#FFA07A,stroke:#333,stroke-width:2px
    classDef core fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef agent fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef tools fill:#90EE90,stroke:#333,stroke-width:2px
    classDef docs fill:#D3D3D3,stroke:#333,stroke-width:2px

    %% User Interface Layer
    subgraph UI["User Interface Layer"]
        WebUI["Web UI"]:::ui
        ChatUI["Chat Interface"]:::ui
        CodeUI["Code Interface"]:::ui
        RealUI["Realtime Voice Interface"]:::ui
    end

    %% Core Framework Layer
    subgraph Core["Core Framework Layer"]
        PraisonAgents["PraisonAI Agents"]:::core
        AutoGen["AutoGen Integration"]:::core
        CrewAI["CrewAI Integration"]:::core
        BaseAgent["Base Agent System"]:::core
    end

    %% Agent Management System
    subgraph AMS["Agent Management System"]
        AgentConfig["Agent Configuration"]:::agent
        TaskMgmt["Task Management"]:::agent
        ProcessOrch["Process Orchestration"]:::agent
        MemoryMgmt["Memory Management"]:::agent
        SelfReflect["Self Reflection System"]:::agent
    end

    %% Tools & Integration Layer
    subgraph Tools["Tools & Integration Layer"]
        ToolsFrame["Tools Framework"]:::tools
        Search["Internet Search"]:::tools
        FileOps["File Operations"]:::tools
        DataProc["Data Processing"]:::tools
        WebScrap["Web Scraping"]:::tools
    end

    %% Model Integration
    subgraph Models["Model Integration"]
        ModelConfig["Model Configuration"]:::core
        ConfigMgmt["Configuration Management"]:::core
    end

    %% Documentation
    subgraph Docs["Documentation"]
        APIDocs["API Documentation"]:::docs
        FeatureDocs["Feature Documentation"]:::docs
        Examples["Example Implementations"]:::docs
        Notebooks["Use Case Notebooks"]:::docs
    end

    %% Relationships
    UI --> Core
    Core --> AMS
    AMS --> Tools
    Tools --> Models

    %% Click Events
    click WebUI "https://github.com/MervinPraison/PraisonAI/tree/main/praisonai/ui/components/"
    click ChatUI "https://github.com/MervinPraison/PraisonAI/blob/main/praisonai/ui/chat.py"
    click CodeUI "https://github.com/MervinPraison/PraisonAI/blob/main/praisonai/ui/code.py"
    click RealUI "https://github.com/MervinPraison/PraisonAI/blob/main/praisonai/ui/realtime.py"
    click PraisonAgents "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/agents/agents.py"
    click AutoGen "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/agents/autoagents.py"
    click BaseAgent "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/agent/agent.py"
    click AgentConfig "https://github.com/MervinPraison/PraisonAI/tree/main/agents/praisonaiagents/agent/"
    click TaskMgmt "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/task/task.py"
    click ProcessOrch "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/process/process.py"
    click MemoryMgmt "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/memory/memory.py"
    click ToolsFrame "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/tools/tools.py"
    click Search "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/tools/duckduckgo_tools.py"
    click FileOps "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/tools/file_tools.py"
    click DataProc "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/tools/pandas_tools.py"
    click WebScrap "https://github.com/MervinPraison/PraisonAI/blob/main/agents/praisonaiagents/tools/spider_tools.py"
    click ModelConfig "https://github.com/MervinPraison/PraisonAI/blob/main/praisonai/inc/models.py"
    click ConfigMgmt "https://github.com/MervinPraison/PraisonAI/blob/main/praisonai/inc/config.py"
    click APIDocs "https://github.com/MervinPraison/PraisonAI/tree/main/docs/api-reference/"
    click FeatureDocs "https://github.com/MervinPraison/PraisonAI/tree/main/docs/features/"
    click Examples "https://github.com/MervinPraison/PraisonAI/tree/main/cookbooks/general/"
    click Notebooks "https://github.com/MervinPraison/PraisonAI/tree/main/cookbooks/notebooks/"
```
