|
# CompI Documentation Index |
|
|
|
Welcome to the CompI docs. All phase guides and project structure are collected here. |
|
|
|
## Quick links |
|
|
|
- Project Structure β PROJECT_STRUCTURE.md |
|
- Phase 1 |
|
- Usage β PHASE1_USAGE.md |
|
- Evaluation (1.D) β PHASE1D_EVALUATION_GUIDE.md |
|
- LoRA (1.E) β PHASE1E_LORA_GUIDE.md |
|
- Phase 2 |
|
- Audio to Image (2.A) β PHASE2A_AUDIO_TO_IMAGE_GUIDE.md |
|
- Data to Image (2.B) β PHASE2B_DATA_TO_IMAGE_GUIDE.md |
|
- Emotion to Image (2.C) β PHASE2C_EMOTION_TO_IMAGE_GUIDE.md |
|
- Real-time Data (2.D) β PHASE2D_REALTIME_DATA_TO_IMAGE_GUIDE.md |
|
- Style Reference (2.E) β PHASE2E_STYLE_REFERENCE_GUIDE.md |
|
- Phase 3 |
|
- Final Dashboard β PHASE3_FINAL_DASHBOARD_GUIDE.md |
|
- Performance (3.E) β PHASE3E_PERFORMANCE_GUIDE.md |
|
- Phase 4 |
|
- Deployment Guide β PHASE4_DEPLOYMENT_GUIDE.md |
|
- Runtime Optimization β PHASE4_RUNTIME_OPTIMIZATION.md |
|
|
|
## Getting started |
|
|
|
- Launch the integrated Phase 3 dashboard: |
|
|
|
- python run_phase3_final_dashboard.py |
|
- Or: streamlit run src/ui/compi_phase3_final_dashboard.py --server.port 8506 |
|
|
|
- Generated images and logs are stored in outputs/ |
|
- Presets live in presets/, export bundles are saved to exports/ |
|
|
|
## Notes |
|
|
|
- Some guides describe optional workflows (e.g., dataset preparation and LoRA training). Those features remain available via src/generators/\* scripts but are not required for using the Phase 3 Final Dashboard. |
|
- If you reorganize folders, ensure src/config.py and the Streamlit app constants continue to point to valid directories. |
|
|