Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,13 +1,96 @@
|
|
| 1 |
---
|
| 2 |
title: Prompt Image Editor
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: purple
|
| 5 |
-
colorTo:
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: mit
|
| 11 |
---
|
|
|
|
| 12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 1 |
---
|
| 2 |
title: Prompt Image Editor
|
| 3 |
+
emoji: ⚡
|
| 4 |
colorFrom: purple
|
| 5 |
+
colorTo: green
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: 6.0.1
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
+
# Prompt Image Editor
|
| 13 |
|
| 14 |
+
A clean and flexible Hugging Face Space for generating images from text prompts and editing existing images using mask-based inpainting.
|
| 15 |
+
The project is optimized for Spaces and uses Gradio + Diffusers with support for custom model IDs through environment variables.
|
| 16 |
+
|
| 17 |
+
---
|
| 18 |
+
|
| 19 |
+
## 🔗 Official Links
|
| 20 |
+
- Website: https://jumplander.org/
|
| 21 |
+
- Hugging Face profile: https://huggingface.co/jumplander
|
| 22 |
+
- GitHub: https://github.com/jumplander
|
| 23 |
+
|
| 24 |
+
> Note: JumpLander branding is referenced only inside this README.
|
| 25 |
+
> The source code (app.py) intentionally contains no branding so this Space can be published under a subsidiary account or page.
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
## 🚀 Features
|
| 30 |
+
- Text → Image generation
|
| 31 |
+
- Image editing (inpainting) with custom masks
|
| 32 |
+
- Adjustable inference steps
|
| 33 |
+
- Adjustable guidance scale
|
| 34 |
+
- Supports any Diffusers-compatible model through `MODEL_ID`
|
| 35 |
+
- Clean, fast, GPU-ready
|
| 36 |
+
|
| 37 |
+
---
|
| 38 |
+
|
| 39 |
+
## 🛠 How to Use (Hugging Face Spaces)
|
| 40 |
+
1. Open your Space.
|
| 41 |
+
2. Go to **Settings → Variables & Secrets**:
|
| 42 |
+
- Add a **Secret**:
|
| 43 |
+
- `HF_API_TOKEN` → Your Hugging Face token (only needed for gated/private models)
|
| 44 |
+
- Add a **Variable**:
|
| 45 |
+
- `MODEL_ID` → e.g. `runwayml/stable-diffusion-v1-5`
|
| 46 |
+
3. Upload:
|
| 47 |
+
- `app.py`
|
| 48 |
+
- `requirements.txt`
|
| 49 |
+
- `README.md`
|
| 50 |
+
- `.huggingface.yaml` (auto-created from metadata)
|
| 51 |
+
4. Enable GPU if required:
|
| 52 |
+
- Settings → **Hardware → GPU**
|
| 53 |
+
|
| 54 |
+
---
|
| 55 |
+
|
| 56 |
+
## 🧪 Recommended Models
|
| 57 |
+
You can switch models anytime:
|
| 58 |
+
|
| 59 |
+
- `runwayml/stable-diffusion-v1-5` (fast & stable)
|
| 60 |
+
- `SG161222/RealVisXL2.0` (high-quality realism)
|
| 61 |
+
- `stabilityai/sdxl-turbo` (very fast)
|
| 62 |
+
- `stabilityai/sdxl-base-1.0` (high detail)
|
| 63 |
+
|
| 64 |
+
Just replace the value of `MODEL_ID`.
|
| 65 |
+
|
| 66 |
+
---
|
| 67 |
+
|
| 68 |
+
## 📄 Environment Variables (Spaces)
|
| 69 |
+
| Name | Type | Description |
|
| 70 |
+
|------|------|-------------|
|
| 71 |
+
| `MODEL_ID` | Variable | Which diffusion model to load |
|
| 72 |
+
| `HF_API_TOKEN` | Secret | Required only for private/gated models |
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## 🧰 Project Structure
|
| 77 |
+
.
|
| 78 |
+
├── app.py # main application
|
| 79 |
+
├── requirements.txt # dependencies
|
| 80 |
+
└── README.md # documentation
|
| 81 |
+
|
| 82 |
+
yaml
|
| 83 |
+
Copy code
|
| 84 |
+
|
| 85 |
+
---
|
| 86 |
+
|
| 87 |
+
## 📘 License
|
| 88 |
+
This project is licensed under the **MIT License**.
|
| 89 |
+
|
| 90 |
+
---
|
| 91 |
+
|
| 92 |
+
## 🤝 Contribution
|
| 93 |
+
Feel free to fork the project, submit improvements, or connect with JumpLander’s community.
|
| 94 |
+
|
| 95 |
+
---
|
| 96 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|