# SpeechT5 Armenian TTS - Project Organization Plan ## Current Project Analysis ### ๐Ÿ“ **Core Application Files** (KEEP) - `app.py` - **Main application** (current working version) - `src/` - **Core source code** (all files needed) - `__init__.py` - Python package initialization - `pipeline.py` - Main TTS pipeline - `model.py` - Model loading and inference - `audio_processing.py` - Audio post-processing - `preprocessing.py` - Text preprocessing - `config.py` - Configuration settings ### ๐Ÿ“„ **Configuration Files** (KEEP) - `requirements.txt` - **Dependencies** (essential) - `spaces.toml` - **HuggingFace Spaces config** (needed for deployment) - `Dockerfile` - **Container configuration** (optional but useful) - `.dockerignore` - Docker ignore file - `.gitattributes` - Git attributes - `.python-version` - Python version specification ### ๐Ÿงช **Development Files** (KEEP) - `tests/test_pipeline.py` - **Unit tests** (good practice) - `deploy.py` - **Deployment helper script** (useful) - `validate_optimization.py` - **Validation script** (useful for testing) ### ๐Ÿ“š **Documentation** (KEEP - ORGANIZE) - `README.md` - **Main documentation** (essential) - `QUICK_START.md` - Quick start guide - `OPTIMIZATION_REPORT.md` - Optimization details - `READY_TO_DEPLOY.md` - Deployment guide ### ๐Ÿ—‘๏ธ **Files to REMOVE/ARCHIVE** #### Development Versions (Multiple app.py variants) - `app_deploy.py` - Archive (development version) - `app_fast.py` - Archive (development version) - `app_final.py` - Archive (development version) - `app_minimal.py` - Archive (development version) - `app_minimal_v2.py` - Archive (development version) - `app_optimized.py` - Archive (development version) - `app_original.py` - Archive (original backup) - `app_simple.py` - Archive (development version) - `app_ultracompat.py` - Archive (development version) #### Temporary Documentation - `DEPLOYMENT_FIX.md` - Archive (temporary fix notes) - `DEPLOYMENT_FIX_SUMMARY.md` - Archive (temporary) - `FINAL_FIX_CONFIRMED.md` - Archive (temporary) #### Cache and Generated Files - `__pycache__/` - Remove (auto-generated) - `src/__pycache__/` - Remove (auto-generated) - `flagged/` - Remove (Gradio temp files) #### Audio Files (Evaluate) - `*.npy` files - Remove (large binary files, should use Git LFS or external storage) - `clips/` - Evaluate (if examples needed, keep small ones) #### Test Files - `test_gradio.py` - Archive (development testing) ## Recommended Project Structure ``` SpeechT5_hy/ โ”œโ”€โ”€ ๐Ÿ“ src/ # Core source code โ”‚ โ”œโ”€โ”€ __init__.py โ”‚ โ”œโ”€โ”€ pipeline.py # Main TTS pipeline โ”‚ โ”œโ”€โ”€ model.py # Model handling โ”‚ โ”œโ”€โ”€ audio_processing.py # Audio processing โ”‚ โ”œโ”€โ”€ preprocessing.py # Text preprocessing โ”‚ โ””โ”€โ”€ config.py # Configuration โ”œโ”€โ”€ ๐Ÿ“ tests/ # Unit tests โ”‚ โ”œโ”€โ”€ __init__.py โ”‚ โ””โ”€โ”€ test_pipeline.py โ”œโ”€โ”€ ๐Ÿ“ docs/ # Documentation โ”‚ โ”œโ”€โ”€ README.md # Moved from root โ”‚ โ”œโ”€โ”€ QUICK_START.md โ”‚ โ”œโ”€โ”€ OPTIMIZATION_REPORT.md โ”‚ โ””โ”€โ”€ DEPLOYMENT.md # Consolidated deployment guide โ”œโ”€โ”€ ๐Ÿ“ scripts/ # Utility scripts โ”‚ โ”œโ”€โ”€ deploy.py โ”‚ โ””โ”€โ”€ validate_optimization.py โ”œโ”€โ”€ ๐Ÿ“ examples/ # Small example files โ”‚ โ””โ”€โ”€ (small audio samples if needed) โ”œโ”€โ”€ ๐Ÿ“ archive/ # Development versions โ”‚ โ””โ”€โ”€ (all app_*.py variants) โ”œโ”€โ”€ app.py # Main application โ”œโ”€โ”€ requirements.txt # Dependencies โ”œโ”€โ”€ spaces.toml # HF Spaces config โ”œโ”€โ”€ Dockerfile # Container config โ”œโ”€โ”€ .gitignore # Git ignore rules โ”œโ”€โ”€ .gitattributes # Git attributes โ”œโ”€โ”€ .python-version # Python version โ””โ”€โ”€ README.md # Main project README ``` ## Action Plan 1. **Create directory structure** 2. **Move files to appropriate locations** 3. **Remove unnecessary files** 4. **Update imports and references** 5. **Create consolidated documentation** 6. **Test the reorganized structure** This organization will make your project: - โœ… **Professional and clean** - โœ… **Easy to navigate** - โœ… **Ready for collaboration** - โœ… **Deployment-ready** - โœ… **Maintainable**