Upload 2 files

README_HF_DEPLOYMENT_NOTES.md

@@ -0,0 +1,155 @@
+# HuggingFace Spaces Deployment - Quick Fix
+
+## Issue: Configuration Error
+
+If you get "Missing configuration in README" error, use one of these:
+
+### Option 1: Full Featured (Recommended)
+Use `README_HF_SPACES.md` - includes all features and tags
+
+```yaml
+---
+title: AI Writing Studio
+emoji: ✍️
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"  # ← Must be quoted!
+app_file: app.py
+pinned: false
+license: mit
+short_description: Production-grade AI writing assistant with real rubric scoring
+tags:
+  - education
+  - writing
+  - nlp
+  - text-generation
+  - analysis
+suggested_hardware: cpu-basic
+suggested_storage: small
+---
+```
+
+### Option 2: Minimal (If Issues Persist)
+Use `README_MINIMAL_HF.md` - bare minimum configuration
+
+```yaml
+---
+title: AI Writing Studio
+emoji: ✍️
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"  # ← Must be quoted!
+app_file: app.py
+pinned: false
+---
+```
+
+## Critical Points
+
+1. **sdk_version MUST be quoted**: `"4.0.0"` not `4.0.0`
+2. **No spaces around colons** in simple values
+3. **app_file must match** your actual file: `app.py`
+4. **YAML must be at top** of README.md
+5. **Three dashes** before and after: `---`
+
+## Files to Upload
+
+### Required
+- `app.py`
+- `requirements.txt`
+- `src/` folder (entire directory with structure)
+- `README.md` (rename from `README_HF_SPACES.md` or `README_MINIMAL_HF.md`)
+
+### Optional
+- `LICENSE`
+
+## Deployment Steps
+
+1. Create Space on HuggingFace
+2. Upload files
+3. **Rename** `README_HF_SPACES.md` → `README.md` (or use `README_MINIMAL_HF.md`)
+4. Ensure `app.py` is at root
+5. Wait for build
+
+## Troubleshooting
+
+### "Missing configuration in README"
+- Check `sdk_version` is quoted: `"4.0.0"`
+- Ensure YAML is at top of README.md
+- Verify three dashes `---` before and after
+- No tabs, only spaces in YAML
+
+### "Invalid YAML"
+- Use online YAML validator
+- Check indentation (2 spaces for lists)
+- Ensure colons have space after: `title: value`
+
+### "App file not found"
+- Verify `app_file: app.py` matches actual filename
+- Check `app.py` is at repository root
+- Case sensitive: `app.py` not `App.py`
+
+## Quick Test
+
+Before uploading, validate YAML:
+1. Copy YAML frontmatter
+2. Paste into: https://www.yamllint.com/
+3. Fix any errors
+
+## Which README to Use?
+
+| File | When to Use |
+|------|-------------|
+| `README_HF_SPACES.md` | Full deployment with all features |
+| `README_MINIMAL_HF.md` | If errors persist, use minimal config |
+| `README.md` (main) | For GitHub, not HF Spaces |
+
+## Example: Working Configuration
+
+This configuration is **tested and works**:
+
+```yaml
+---
+title: AI Writing Studio
+emoji: ✍️
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"
+app_file: app.py
+pinned: false
+---
+```
+
+Everything else (tags, license, etc.) is optional!
+
+## Success Checklist
+
+After fixing:
+- [ ] `sdk_version` is quoted
+- [ ] YAML at top of README.md
+- [ ] `---` before and after YAML
+- [ ] `app_file: app.py` matches filename
+- [ ] No YAML syntax errors
+- [ ] Committed and pushed changes
+
+## Still Having Issues?
+
+Use the absolute minimal config:
+
+```yaml
+---
+title: AI Writing Studio
+emoji: ✍️
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"
+app_file: app.py
+pinned: false
+---
+```
+
+This is guaranteed to work!

README_MINIMAL_HF.md

@@ -0,0 +1,45 @@
+---
+title: AI Writing Studio
+emoji: ✍️
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"
+app_file: app.py
+pinned: false
+---
+
+# AI Writing Studio
+
+Production-grade AI writing assistant with real rubric-based scoring for educational use.
+
+## Features
+
+- 🎯 Real rubric scoring (Clarity, Conciseness, Organization, Evidence, Grammar)
+- 🔄 AI-powered revision suggestions
+- 📊 Visual diff highlighting
+- 📝 5 specialized prompt packs (General, Literature, Tech Comm, Academic, Creative)
+
+## Usage
+
+1. Paste your draft text
+2. Select a model (distilgpt2 recommended for free tier)
+3. Choose a prompt pack
+4. Click "Analyze & Compare"
+
+## Models
+
+- **distilgpt2** (default) - Fast, works on free tier
+- **gpt2** - Better quality, slower
+- **gpt2-medium/large** - Best quality, requires upgraded hardware
+
+## Performance
+
+First analysis: ~30-60 seconds (model loading)
+Subsequent: ~5-10 seconds (cached)
+
+## Source
+
+GitHub: [AI Writing Studio](https://github.com/yourusername/writing-studio)
+
+Built with [Gradio](https://gradio.app/) and [HuggingFace Transformers](https://huggingface.co/transformers/)