docs/PROJECT_ORGANIZATION_PLAN.md

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