|
# π CompI Phase 4 Deployment Checklist |
|
|
|
## Prerequisites |
|
- [ ] GitHub account with your CompI repository |
|
- [ ] Hugging Face account ([sign up here](https://huggingface.co/join)) |
|
- [ ] OpenWeatherMap API key (optional, for real-time weather data) |
|
|
|
## Phase 4.A: Repository Preparation β
|
|
- [x] `packages.txt` created with system dependencies |
|
- [x] `.gitattributes` created for Git LFS support |
|
- [x] `requirements.txt` verified and ready |
|
- [x] GitHub Actions workflow created |
|
|
|
## Phase 4.B: Hugging Face Space Setup |
|
|
|
### Step 1: Create Space |
|
1. [ ] Go to [Hugging Face Spaces](https://huggingface.co/spaces) |
|
2. [ ] Click "Create new Space" |
|
3. [ ] Fill in details: |
|
- **Owner**: Your username |
|
- **Space name**: `compi-final-dashboard` (or your choice) |
|
- **License**: Apache 2.0 (recommended) |
|
- **SDK**: Streamlit |
|
- **Hardware**: CPU basic (free) |
|
- **Visibility**: Public |
|
|
|
### Step 2: Configure Space |
|
4. [ ] In your new Space, click "Files" β "README.md" β Edit |
|
5. [ ] Replace content with this header: |
|
|
|
```markdown |
|
--- |
|
title: CompI β Final Dashboard |
|
emoji: π¨ |
|
sdk: streamlit |
|
app_file: src/ui/compi_phase3_final_dashboard.py |
|
pinned: false |
|
--- |
|
|
|
# CompI - Multimodal AI Art Generation Platform |
|
|
|
The ultimate creative platform combining text, audio, data, emotion, and real-time inputs for AI art generation. |
|
|
|
## Features |
|
|
|
π§© **Multimodal Inputs** - Text, Audio, Data, Emotion, Real-time feeds |
|
πΌοΈ **Advanced References** - Multi-image upload with role assignment |
|
βοΈ **Model Management** - SD 1.5/SDXL switching, LoRA integration |
|
πΌοΈ **Professional Gallery** - Filtering, rating, annotation system |
|
πΎ **Preset Management** - Save/load complete configurations |
|
π¦ **Export System** - Complete bundles with metadata |
|
|
|
## Usage |
|
|
|
1. Configure your inputs in the "Inputs" tab |
|
2. Upload reference images in "Advanced References" |
|
3. Choose your model and performance settings |
|
4. Generate with intelligent fusion of all inputs |
|
5. Review results in the gallery and export bundles |
|
|
|
Built with Streamlit, PyTorch, and Diffusers. |
|
``` |
|
|
|
6. [ ] Commit the README changes |
|
|
|
### Step 3: Add Secrets (Optional) |
|
7. [ ] Go to Space Settings β Repository secrets |
|
8. [ ] Add secret: `OPENWEATHER_KEY` = `your_api_key_here` |
|
|
|
## Phase 4.C: GitHub Actions Setup |
|
|
|
### Step 1: Get Hugging Face Token |
|
9. [ ] Go to [HF Settings β Access Tokens](https://huggingface.co/settings/tokens) |
|
10. [ ] Click "New token" |
|
11. [ ] Name: `CompI Deployment` |
|
12. [ ] Type: **Write** |
|
13. [ ] Click "Generate" |
|
14. [ ] **Copy the token** (you won't see it again!) |
|
|
|
### Step 2: Add GitHub Secrets |
|
15. [ ] Go to your GitHub repo β Settings β Secrets and variables β Actions |
|
16. [ ] Click "New repository secret" |
|
17. [ ] Add secret 1: |
|
- **Name**: `HF_TOKEN` |
|
- **Secret**: Paste your HF token from step 14 |
|
18. [ ] Add secret 2: |
|
- **Name**: `HF_SPACE_ID` |
|
- **Secret**: `your-username/your-space-name` (e.g., `AXRZCE/compi-final-dashboard`) |
|
|
|
## Phase 4.D: Test Deployment |
|
|
|
### Step 1: Trigger First Deploy |
|
19. [ ] In your GitHub repo, make a small change (e.g., edit README.md) |
|
20. [ ] Commit to `main` branch: |
|
```bash |
|
git add . |
|
git commit -m "Initial deployment setup" |
|
git push origin main |
|
``` |
|
|
|
### Step 2: Monitor Deployment |
|
21. [ ] Go to GitHub repo β Actions tab |
|
22. [ ] Watch the "Deploy to HF Spaces (on main)" workflow |
|
23. [ ] Verify it completes successfully (green checkmark) |
|
|
|
### Step 3: Test Your Space |
|
24. [ ] Go to your HF Space URL: `https://your-username-your-space.hf.space` |
|
25. [ ] Wait for the app to build (first time takes 5-10 minutes) |
|
26. [ ] Test basic functionality: |
|
- [ ] Enter a text prompt |
|
- [ ] Generate an image |
|
- [ ] Check that the interface loads properly |
|
|
|
## Phase 4.E: Production Workflow |
|
|
|
### For Future Updates |
|
- [ ] Create feature branches for new development |
|
- [ ] Test changes locally: `streamlit run src/ui/compi_phase3_final_dashboard.py` |
|
- [ ] Open Pull Request to `main` |
|
- [ ] Merge PR β Automatic deployment to HF Space |
|
|
|
### Rollback Process |
|
- [ ] If deployment breaks, revert the commit on `main` |
|
- [ ] GitHub Actions will automatically redeploy the previous version |
|
|
|
## Troubleshooting |
|
|
|
### Common Issues |
|
- **Space won't start**: Check the build logs in HF Space β Logs |
|
- **GitHub Action fails**: Check repo secrets are set correctly |
|
- **App crashes**: Verify `app_file` path in Space README is correct |
|
- **Missing dependencies**: Check `requirements.txt` and `packages.txt` |
|
|
|
### Support Resources |
|
- [Hugging Face Spaces Documentation](https://huggingface.co/docs/hub/spaces) |
|
- [GitHub Actions Documentation](https://docs.github.com/en/actions) |
|
- [Streamlit Documentation](https://docs.streamlit.io/) |
|
|
|
## Success! π |
|
|
|
Once complete, your CompI platform will be: |
|
- β
Publicly accessible at your HF Space URL |
|
- β
Automatically deployed on every `main` branch update |
|
- β
Running on free Hugging Face infrastructure |
|
- β
Ready for users worldwide to create multimodal AI art |
|
|
|
**Share your Space URL**: `https://your-username-your-space.hf.space` |
|
|