How faizan-codes/text-summarizer-project works
Main Components
a) Data Layer:
• Data Ingestion Component
• Configuration Management (config.yaml, params.yaml)
b) Core Processing Layer:
• Text Summarizer Pipeline
• Component Manager
• Entity Management
c) Application Layer:
• FastAPI/Flask Application (app.py)
• Main Execution Module (main.py)
d) Infrastructure Layer:
• Docker Container
• GitHub Workflows (CI/CD)
[Client/User Interface]
• ↓
[Web Application Layer (app.py)]
• ↓
[Pipeline Orchestration (main.py)]
• ↓
[Text Summarizer Components]
• ↓
[Data Management Layer]
Component Relationships
• Rectangles: Core processing components
• Hexagons: Entry points (app.py, main.py)
Detailed Component Breakdown
a) Configuration Management (Yellow):
• [config.yaml] ←→ [params.yaml]
• ↓
• [Configuration Manager]
b) Pipeline Structure (Blue):
• [Pipeline Orchestrator]
• ↓
• [Stage 01: Data Ingestion] → [Future Stages]
c) Component Architecture (Green):
• [Component Manager]
• ↓
• [Data Ingestion Component] → [Utils] → [Logging]
Important Elements to Highlight
• Modular structure of the src/textSummarizer directory
• Pipeline stages (currently showing data_ingestion)
• Configuration flow from yaml files to components
• Logging and utility functions as supporting services
Technical Details
• Docker containerization boundary
• GitHub Actions workflow integration
• Python package structure
• Research notebook integration