๐ Automatic deploy
Browse files- README.md +269 -0
- model-index.json +38 -0
README.md
ADDED
|
@@ -0,0 +1,269 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ๐ค Meena - Enterprise AI Pipeline
|
| 2 |
+
|
| 3 |
+
[](https://github.com/sheikh-vegeta/Meena/actions)
|
| 4 |
+
[](https://python.org)
|
| 5 |
+
[](https://huggingface.co)
|
| 6 |
+
[](https://github.com/sheikh-vegeta/Meena/blob/main/LICENSE)
|
| 7 |
+
[](https://github.com/sheikh-vegeta/Meena/stargazers)
|
| 8 |
+
|
| 9 |
+
<div align="center">
|
| 10 |
+
|
| 11 |
+
**๐ An enterprise-grade CI/CD pipeline for training, benchmarking, and deploying the Meena conversational AI model**
|
| 12 |
+
|
| 13 |
+
*Designed with automation, efficiency, and multilingual support (Bengali & English) at its core*
|
| 14 |
+
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
> *"เฆฎเฆพเฆจเฆฌเฆฟเฆ เฆธเฆเฆฒเฆพเฆช, เฆฌเฆพเฆเฆฒเฆพเฆฐ เฆเงเฆเฆฏเฆผเฆพเฆฏเฆผ โ Building the future of multilingual conversational AI"*
|
| 18 |
+
|
| 19 |
+
</div>
|
| 20 |
+
|
| 21 |
+
## โจ Features
|
| 22 |
+
|
| 23 |
+
๐ **Enterprise-Ready Pipeline**
|
| 24 |
+
- โ๏ธ **Automated CI/CD** โ End-to-end automation with GitHub Actions
|
| 25 |
+
- ๐ **Smart Change Detection** โ Runs only the jobs affected by your commits
|
| 26 |
+
- ๐ **Multi-environment Support** โ Main, develop, and feature branch workflows
|
| 27 |
+
|
| 28 |
+
๐ง **Advanced AI Training**
|
| 29 |
+
- ๐ฏ **LoRA-based Fine-tuning** โ Efficient training on models like DialoGPT
|
| 30 |
+
- ๐ **Integrated Benchmarking** โ Performance evaluation with comprehensive metrics
|
| 31 |
+
- ๐ **Multilingual Support** โ Bengali (เฆฌเฆพเฆเฆฒเฆพ) and English training datasets
|
| 32 |
+
|
| 33 |
+
๐ฆ **Professional Deployment**
|
| 34 |
+
- ๐ค **Hugging Face Integration** โ Automatic model publishing and versioning
|
| 35 |
+
- ๐ **Auto-generated Model Cards** โ Detailed documentation for every model release
|
| 36 |
+
- ๐ **GitHub Releases** โ Automated versioning and artifact management
|
| 37 |
+
- ๐ **Smart Notifications** โ Keep your team updated on pipeline status
|
| 38 |
+
|
| 39 |
+
## ๐ ๏ธ Architecture Overview
|
| 40 |
+
|
| 41 |
+
```mermaid
|
| 42 |
+
flowchart TD
|
| 43 |
+
A[๐ Push to Repository] --> B[๐ต๏ธ Change Detection]
|
| 44 |
+
B --> C{๐ Changes Detected?}
|
| 45 |
+
C -->|Training Scripts| D[๐ Model Training]
|
| 46 |
+
C -->|Benchmark Scripts| E[๐ Performance Evaluation]
|
| 47 |
+
C -->|Config Changes| F[โ๏ธ Pipeline Update]
|
| 48 |
+
|
| 49 |
+
D --> G[๐ Training Metrics]
|
| 50 |
+
E --> H[๐ Benchmark Results]
|
| 51 |
+
|
| 52 |
+
G --> I[๐ Model Publishing]
|
| 53 |
+
H --> I
|
| 54 |
+
I --> J[๐ค Hugging Face Hub]
|
| 55 |
+
I --> K[๐ฆ GitHub Release]
|
| 56 |
+
|
| 57 |
+
J --> L[๐งช Inference Testing]
|
| 58 |
+
K --> L
|
| 59 |
+
L --> M[โ
Quality Gates]
|
| 60 |
+
M --> N[๐ Team Notification]
|
| 61 |
+
|
| 62 |
+
style A fill:#e1f5fe
|
| 63 |
+
style D fill:#f3e5f5
|
| 64 |
+
style E fill:#fff3e0
|
| 65 |
+
style I fill:#e8f5e8
|
| 66 |
+
style N fill:#fce4ec
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
## ๐ Quick Start
|
| 70 |
+
|
| 71 |
+
### Prerequisites
|
| 72 |
+
```bash
|
| 73 |
+
# Python 3.8+ required
|
| 74 |
+
python --version
|
| 75 |
+
|
| 76 |
+
# Install dependencies
|
| 77 |
+
pip install -r requirements.txt
|
| 78 |
+
```
|
| 79 |
+
|
| 80 |
+
### Local Development
|
| 81 |
+
```bash
|
| 82 |
+
# Clone the repository
|
| 83 |
+
git clone https://github.com/sheikh-vegeta/Meena.git
|
| 84 |
+
cd Meena
|
| 85 |
+
|
| 86 |
+
# Set up environment
|
| 87 |
+
python -m venv meena-env
|
| 88 |
+
source meena-env/bin/activate # On Windows: meena-env\Scripts\activate
|
| 89 |
+
|
| 90 |
+
# Install requirements
|
| 91 |
+
pip install -r requirements.txt
|
| 92 |
+
|
| 93 |
+
# Run training locally
|
| 94 |
+
python train.py
|
| 95 |
+
|
| 96 |
+
# Run benchmarking
|
| 97 |
+
python benchmark.py
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
## ๐ CI/CD Pipeline Details
|
| 101 |
+
|
| 102 |
+
The complete automation logic is defined in `.github/workflows/auto-train-publish.yml`
|
| 103 |
+
|
| 104 |
+
### ๐ฏ Trigger Conditions
|
| 105 |
+
- โ
**Push to `main`** โ Full pipeline execution
|
| 106 |
+
- โ
**Push to `develop`** โ Training and benchmarking only
|
| 107 |
+
- โ
**Pull Requests** โ Validation and testing
|
| 108 |
+
- โ
**Manual Dispatch** โ On-demand execution via GitHub Actions
|
| 109 |
+
|
| 110 |
+
### ๐ Pipeline Jobs
|
| 111 |
+
|
| 112 |
+
| Job | Description | Triggers |
|
| 113 |
+
|-----|-------------|----------|
|
| 114 |
+
| ๐ต๏ธ **detect-changes** | Analyzes git diff to determine required pipeline stages | Always |
|
| 115 |
+
| ๐ **train** | Executes model training with LoRA fine-tuning | Training scripts modified |
|
| 116 |
+
| ๐ **benchmark** | Runs performance evaluation and generates metrics | Model or benchmark changes |
|
| 117 |
+
| ๐ **publish** | Publishes to Hugging Face Hub & creates GitHub release | Successful training completion |
|
| 118 |
+
| ๐งช **test** | Validates deployed model via Inference API | Post-deployment |
|
| 119 |
+
| ๐ **notify** | Sends pipeline status to configured channels | Pipeline completion |
|
| 120 |
+
|
| 121 |
+
## ๐ Benchmarking & Metrics
|
| 122 |
+
|
| 123 |
+
Meena includes comprehensive evaluation metrics:
|
| 124 |
+
|
| 125 |
+
- ๐ **Perplexity Scores** โ Language model quality assessment
|
| 126 |
+
- ๐ฏ **BLEU Scores** โ Translation and generation quality
|
| 127 |
+
- ๐ฃ๏ธ **Conversational Metrics** โ Dialogue coherence and relevance
|
| 128 |
+
- โก **Performance Benchmarks** โ Inference speed and memory usage
|
| 129 |
+
|
| 130 |
+
> *เฆฌเฆพเฆเฆฒเฆพ เฆฎเงเฆเงเฆฐเฆฟเฆเงเฆธ:* "เฆเฆฎเฆพเฆฆเงเฆฐ เฆฌเงเฆเงเฆเฆฎเฆพเฆฐเงเฆเฆฟเฆ ๏ฟฝ๏ฟฝเฆฟเฆธเงเฆเงเฆฎ เฆฌเฆพเฆเฆฒเฆพ เฆญเฆพเฆทเฆพเฆฐ เฆเฆจเงเฆฏ เฆฌเฆฟเฆถเงเฆทเฆญเฆพเฆฌเง เฆ
เฆชเงเฆเฆฟเฆฎเฆพเฆเฆ เฆเฆฐเฆพ เฆนเฆฏเฆผเงเฆเงเฅค"
|
| 131 |
+
|
| 132 |
+
## ๐ Multilingual Support
|
| 133 |
+
|
| 134 |
+
### Bengali (เฆฌเฆพเฆเฆฒเฆพ) Integration
|
| 135 |
+
- ๐ **Native Bengali Datasets** โ Curated conversational data
|
| 136 |
+
- ๐ค **Proper Tokenization** โ Bengali script-aware processing
|
| 137 |
+
- ๐ญ **Cultural Context** โ Bengali idioms and expressions
|
| 138 |
+
- โ
**Quality Assurance** โ Bengali-specific evaluation metrics
|
| 139 |
+
|
| 140 |
+
### Training Data Structure
|
| 141 |
+
```
|
| 142 |
+
datasets/
|
| 143 |
+
โโโ bengali/
|
| 144 |
+
โ โโโ conversations.json
|
| 145 |
+
โ โโโ formal_dialogues.json
|
| 146 |
+
โ โโโ casual_chat.json
|
| 147 |
+
โโโ english/
|
| 148 |
+
โ โโโ dialogpt_data.json
|
| 149 |
+
โ โโโ general_conversations.json
|
| 150 |
+
โโโ mixed/
|
| 151 |
+
โโโ bilingual_pairs.json
|
| 152 |
+
```
|
| 153 |
+
|
| 154 |
+
## ๐ Model Publishing Workflow
|
| 155 |
+
|
| 156 |
+
### Automatic Publishing
|
| 157 |
+
1. ๐ฏ **Training Completion** โ Model artifacts generated
|
| 158 |
+
2. ๐ **Model Card Generation** โ Documentation created automatically
|
| 159 |
+
3. ๐ค **Hugging Face Upload** โ Model pushed to Hub with versioning
|
| 160 |
+
4. ๐ฆ **GitHub Release** โ Tagged release with artifacts
|
| 161 |
+
5. ๐งช **Validation Testing** โ Inference API smoke tests
|
| 162 |
+
|
| 163 |
+
### Model Card Features
|
| 164 |
+
- ๐ **Performance Metrics** โ Comprehensive benchmark results
|
| 165 |
+
- ๐ฏ **Use Cases** โ Detailed application scenarios
|
| 166 |
+
- โ ๏ธ **Limitations** โ Honest assessment of model boundaries
|
| 167 |
+
- ๐ **Training Details** โ Complete training configuration
|
| 168 |
+
- ๐ **Language Support** โ Bengali and English capabilities
|
| 169 |
+
|
| 170 |
+
## ๐ก๏ธ Quality Assurance
|
| 171 |
+
|
| 172 |
+
### Automated Testing
|
| 173 |
+
- โ
**Unit Tests** โ Core functionality validation
|
| 174 |
+
- ๐ **Integration Tests** โ End-to-end pipeline verification
|
| 175 |
+
- ๐งช **Model Validation** โ Output quality assessment
|
| 176 |
+
- ๐ **Performance Regression** โ Benchmark comparison
|
| 177 |
+
|
| 178 |
+
### Code Quality
|
| 179 |
+
- ๐ **Linting** โ PEP 8 compliance with flake8
|
| 180 |
+
- ๐จ **Formatting** โ Automatic formatting with black
|
| 181 |
+
- ๐ **Documentation** โ Comprehensive docstrings
|
| 182 |
+
- ๐ **Security Scanning** โ Dependency vulnerability checks
|
| 183 |
+
|
| 184 |
+
## ๐ Notification System
|
| 185 |
+
|
| 186 |
+
Stay updated with intelligent notifications:
|
| 187 |
+
|
| 188 |
+
- ๐ง **Email Alerts** โ Critical pipeline failures
|
| 189 |
+
- ๐ฌ **Slack Integration** โ Team channel updates
|
| 190 |
+
- ๐จ **Discord Webhooks** โ Community notifications
|
| 191 |
+
- ๐ฑ **GitHub Notifications** โ Built-in issue tracking
|
| 192 |
+
|
| 193 |
+
## ๐ค Contributing
|
| 194 |
+
|
| 195 |
+
We welcome contributions! Please follow these guidelines:
|
| 196 |
+
|
| 197 |
+
### Development Workflow
|
| 198 |
+
1. ๐ด **Fork** the repository
|
| 199 |
+
2. ๐ฟ **Create** a feature branch (`git checkout -b feature/amazing-feature`)
|
| 200 |
+
3. โ
**Test** your changes thoroughly
|
| 201 |
+
4. ๐ **Commit** with descriptive messages
|
| 202 |
+
5. ๐ **Push** to your branch
|
| 203 |
+
6. ๐ฌ **Open** a Pull Request
|
| 204 |
+
|
| 205 |
+
### Contribution Areas
|
| 206 |
+
- ๐ง **Model Improvements** โ Better architectures and training techniques
|
| 207 |
+
- ๐ **Language Support** โ Additional language integrations
|
| 208 |
+
- ๐ **Benchmarking** โ New evaluation metrics and datasets
|
| 209 |
+
- ๐ง **Infrastructure** โ Pipeline optimizations and tooling
|
| 210 |
+
- ๐ **Documentation** โ Tutorials, guides, and examples
|
| 211 |
+
|
| 212 |
+
> *เฆ
เฆฌเฆฆเฆพเฆจเฆเฆพเฆฐเงเฆฆเงเฆฐ เฆเฆจเงเฆฏ:* "เฆเฆชเฆจเฆพเฆฐ เฆ
เฆฌเฆฆเฆพเฆจ เฆฌเฆพเฆเฆฒเฆพ AI-เฆเฆฐ เฆญเฆฌเฆฟเฆทเงเฆฏเง เฆเฆกเฆผเฆคเง เฆธเฆพเฆนเฆพเฆฏเงเฆฏ เฆเฆฐเฆฌเงเฅค"
|
| 213 |
+
|
| 214 |
+
## ๐ Repository Structure
|
| 215 |
+
|
| 216 |
+
```
|
| 217 |
+
Meena/
|
| 218 |
+
โโโ ๐ README.md # This file
|
| 219 |
+
โโโ โ๏ธ requirements.txt # Python dependencies
|
| 220 |
+
โโโ ๐งช train.py # Model training script
|
| 221 |
+
โโโ ๐ benchmark.py # Performance evaluation
|
| 222 |
+
โโโ ๐ generate_model_card.py # Documentation generation
|
| 223 |
+
โโโ ๐ง config/
|
| 224 |
+
โ โโโ training_config.yaml # Training parameters
|
| 225 |
+
โ โโโ model_config.yaml # Model architecture
|
| 226 |
+
โ โโโ benchmark_config.yaml # Evaluation settings
|
| 227 |
+
โโโ ๐ datasets/
|
| 228 |
+
โ โโโ bengali/ # Bengali training data
|
| 229 |
+
โ โโโ english/ # English training data
|
| 230 |
+
โ โโโ mixed/ # Bilingual datasets
|
| 231 |
+
โโโ ๐ฏ models/
|
| 232 |
+
โ โโโ base/ # Base model checkpoints
|
| 233 |
+
โ โโโ fine_tuned/ # Fine-tuned outputs
|
| 234 |
+
โโโ ๐ benchmarks/
|
| 235 |
+
โ โโโ results/ # Benchmark outputs
|
| 236 |
+
โ โโโ metrics/ # Performance data
|
| 237 |
+
โโโ ๐ .github/
|
| 238 |
+
โโโ workflows/
|
| 239 |
+
โโโ auto-train-publish.yml # CI/CD pipeline
|
| 240 |
+
```
|
| 241 |
+
|
| 242 |
+
## ๐ License
|
| 243 |
+
|
| 244 |
+
This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.
|
| 245 |
+
|
| 246 |
+
## ๐ Acknowledgments
|
| 247 |
+
|
| 248 |
+
- ๐ค **Hugging Face** โ For the incredible transformers library and model hub
|
| 249 |
+
- ๐ง **OpenAI** โ For inspiring conversational AI research
|
| 250 |
+
- ๐ **Bengali NLP Community** โ For dataset contributions and feedback
|
| 251 |
+
- ๐ฅ **Contributors** โ Everyone who has helped improve Meena
|
| 252 |
+
|
| 253 |
+
## ๐ Support & Contact
|
| 254 |
+
|
| 255 |
+
- ๐ง **Issues**: [GitHub Issues](https://github.com/sheikh-vegeta/Meena/issues)
|
| 256 |
+
- ๐ฌ **Discussions**: [GitHub Discussions](https://github.com/sheikh-vegeta/Meena/discussions)
|
| 257 |
+
- ๐ **Documentation**: [Wiki](https://github.com/sheikh-vegeta/Meena/wiki)
|
| 258 |
+
|
| 259 |
+
---
|
| 260 |
+
|
| 261 |
+
<div align="center">
|
| 262 |
+
|
| 263 |
+
**๐ฎ Building the Future of Multilingual Conversational AI**
|
| 264 |
+
|
| 265 |
+
*Made with โค๏ธ by the Meena Team*
|
| 266 |
+
|
| 267 |
+
**[โญ Star this repo](https://github.com/sheikh-vegeta/Meena) if you found it helpful!**
|
| 268 |
+
|
| 269 |
+
</div>
|
model-index.json
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"language": ["en", "bn"],
|
| 3 |
+
"license": "apache-2.0",
|
| 4 |
+
"tags": [
|
| 5 |
+
"meena",
|
| 6 |
+
"conversational-ai",
|
| 7 |
+
"multilingual",
|
| 8 |
+
"bengali",
|
| 9 |
+
"fine-tuned",
|
| 10 |
+
"enterprise-pipeline"
|
| 11 |
+
],
|
| 12 |
+
"pipeline_tag": "text-generation",
|
| 13 |
+
"library_name": "transformers",
|
| 14 |
+
"model-index": [
|
| 15 |
+
{
|
| 16 |
+
"name": "Meena",
|
| 17 |
+
"results": [
|
| 18 |
+
{
|
| 19 |
+
"model": {
|
| 20 |
+
"name": "likhonsheikh/Meena"
|
| 21 |
+
},
|
| 22 |
+
"metrics": [
|
| 23 |
+
{
|
| 24 |
+
"name": "Perplexity",
|
| 25 |
+
"type": "perplexity",
|
| 26 |
+
"value": "N/A"
|
| 27 |
+
}
|
| 28 |
+
],
|
| 29 |
+
"tasks": [
|
| 30 |
+
{
|
| 31 |
+
"type": "text-generation"
|
| 32 |
+
}
|
| 33 |
+
]
|
| 34 |
+
}
|
| 35 |
+
]
|
| 36 |
+
}
|
| 37 |
+
]
|
| 38 |
+
}
|