Skip to content

Commit 77ce384

Browse files
docs: Add system architecture diagram and fix README inaccuracies
- Add comprehensive system architecture diagram (graph.png) to README - Rename section from 'MCP Architecture' to 'System Architecture' for broader scope - Fix incorrect claims about batch processing, GPU acceleration, and zero-shot classification - Correct output formats to reflect actual implementation (JSON only) - Update repository URL and example files to match actual codebase - Remove inaccurate claims about multilingual workflows and batch processing - Add missing example file (communicator_email_tester.py) to documentation These changes ensure README accurately reflects the actual capabilities and implementation of the Sum-It-Up Agent system.
1 parent 05c8de6 commit 77ce384

3 files changed

Lines changed: 51 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The project is designed around **independent services** with clear boundaries, s
4848
### 1) Install
4949

5050
```bash
51-
git clone https://github.com/yourusername/sum-it-up-agent.git
51+
git clone https://github.com/iosifidisvasileios/sum-it-up-agent.git
5252
cd sum-it-up-agent
5353
poetry install
5454
```
@@ -86,7 +86,7 @@ python -m src.sum_it_up_agent.app /path/to/audio.mp4 "summarize this meeting and
8686
At runtime, the agent performs a pipeline like:
8787

8888
1. **Ingest & normalize** audio/video
89-
2. **(Optional) diarization** for speaker separation
89+
2. **Speaker diarization** for speaker separation
9090
3. **Transcription** (Whisper-family models)
9191
4. **Meeting-type classification** (zero-shot / ensembles)
9292
5. **Instruction-aware summarization** using meeting templates + user instructions
@@ -96,7 +96,9 @@ Outputs can be saved as structured artifacts (e.g., JSON) for downstream workflo
9696

9797
---
9898

99-
## MCP Architecture
99+
## System Architecture
100+
101+
![System Architecture](graph.png)
100102

101103
```
102104
Sum-It-Up App (Singleton)
@@ -122,19 +124,18 @@ Sum-It-Up App (Singleton)
122124
### Audio processing
123125
- Multi-format input (MP3, MP4, WAV, M4A, FLAC, …)
124126
- Optional speaker diarization
125-
- High-quality transcription with GPU acceleration where available
126-
- Batch-friendly workflows (parallelizable stages)
127+
- High-quality transcription with Whisper models
127128

128129
### Topic classification
129-
- Zero-shot meeting type detection (no training data required)
130+
- Meeting type detection using ensemble methods
130131
- Confidence scoring / uncertainty-aware output
131132
- Support for common meeting classes (planning, retro, interview, support call, etc.)
132133

133134
### Summarization
134135
- File-backed prompt templates for meeting-specific structure
135136
- Multiple summary types (standard, action items, decisions, key points, executive, …)
136137
- Multi-provider backends (hosted and local)
137-
- Output formats: JSON, TXT, CSV (and extensible)
138+
- Output formats: JSON (and extensible)
138139

139140
### Communication
140141
- **Email delivery** with HTML-formatted summaries
@@ -269,13 +270,14 @@ python -m unittest discover -s tests
269270
- `tests/examples/summarizer_examples.py`
270271
- `tests/examples/topic_classification_examples.py`
271272
- `tests/examples/prompt_parser_example.py`
273+
- `tests/examples/communicator_email_tester.py`
272274

273275
---
274276

275277
## Roadmap
276278

277279
### Near-term
278-
- More robust multilingual workflows (transcription + summarization)
280+
- Enhanced audio processing workflows (transcription + summarization)
279281
- Additional communicator backends (Discord, Teams, Telegram)
280282
- Stronger observability (structured logs, tracing, evaluation dashboards)
281283

architecture.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
graph TB
2+
subgraph "Client Layer"
3+
CLI[Interactive Interface]
4+
APP[Python Application]
5+
end
6+
7+
subgraph "Orchestration Layer"
8+
ORCHESTRATOR[AudioProcessingAgent]
9+
PARSER[PromptParser]
10+
end
11+
12+
subgraph "MCP Services Layer"
13+
AUDIO_MCP[Audio Processor MCP<br/>Port 9001]
14+
TOPIC_MCP[Topic Classifier MCP<br/>Port 9002]
15+
SUMMARIZER_MCP[Summarizer MCP<br/>Port 9000]
16+
COMMUNICATOR_MCP[Communicator MCP<br/>Port 9003]
17+
end
18+
19+
subgraph "Communication Backends"
20+
EMAIL[Email Service]
21+
SLACK[Slack Webhook]
22+
PDF[PDF Exporter]
23+
end
24+
25+
CLI --> ORCHESTRATOR
26+
APP --> ORCHESTRATOR
27+
ORCHESTRATOR --> PARSER
28+
29+
ORCHESTRATOR --> AUDIO_MCP
30+
ORCHESTRATOR --> TOPIC_MCP
31+
ORCHESTRATOR --> SUMMARIZER_MCP
32+
ORCHESTRATOR --> COMMUNICATOR_MCP
33+
34+
COMMUNICATOR_MCP --> EMAIL
35+
COMMUNICATOR_MCP --> SLACK
36+
COMMUNICATOR_MCP --> PDF
37+
38+
AUDIO_MCP --> ORCHESTRATOR
39+
TOPIC_MCP --> ORCHESTRATOR
40+
SUMMARIZER_MCP --> ORCHESTRATOR
41+
COMMUNICATOR_MCP --> ORCHESTRATOR

graph.png

734 KB
Loading

0 commit comments

Comments
 (0)