Welcome to the complete documentation of the chaM3Leon framework. This page will guide you through all available resources.
| Document | Description | Audience |
|---|---|---|
| SUMMARY.md | Executive summary for decision makers | C-Level, Managers |
| VALUE_PROPOSITION.md | Discover the value and advantages of chaM3Leon | Everyone |
| GETTING_STARTED.md | Step-by-step guide for your first project | Developers |
| ARCHITECTURE.md | Understand the framework architecture | Architects, Team Leads |
| USE_CASES.md | Practical examples of real applications | Business, Developers |
| FAQ.md | Frequently asked questions and answers | Everyone |
| Document | Description |
|---|---|
| CONFIG_LIST.md | Complete configuration guide |
| APPS_NAMING.md | Application naming conventions |
| Layer | Documentation | Language | Description |
|---|---|---|---|
| Batch | README | Java | Historical data batch processing |
| Speed | README | Java | Real-time streaming processing |
| Harvester | README | Java | Data collection from external sources |
| Serving | README | Java/Spring Boot | REST API for data distribution |
| ML Runner | GitHub | Python | Machine Learning and MLOps |
- Framework Presentation (Work in progress) - General overview
- Batch and Speed Layer Demo (Work in progress) - Practical example
| Repository | Purpose | Link |
|---|---|---|
| chaM3Leon Main | Main framework | GitHub |
| PyChaM3Leon | ML Runner (Python) | GitHub |
| docker_chaM3Leon | Docker setup | GitHub |
chaM3Leon Framework
│
├── Basic Concepts
│ ├── VALUE_PROPOSITION.md (Why use it?)
│ └── ARCHITECTURE.md (How does it work?)
│
├── Practice
│ ├── GETTING_STARTED.md (How to start?)
│ └── USE_CASES.md (Real examples)
│
├── Layers (Java/Spark)
│ ├── Batch Layer → Historical processing
│ ├── Speed Layer → Real-time processing
│ ├── Harvester Layer → Data collection
│ └── Serving Layer → API distribution
│
├── Layers (Python)
│ └── ML Runner → Machine Learning
│
└── References
├── CONFIG_LIST.md (Configurations)
└── APPS_NAMING.md (Conventions)
- Check the documentation - The answer is probably here
- Watch the videos - Step-by-step tutorials
- GitHub Issues - For bugs and feature requests
Back to main README