prompt-image-editor / README.md
os-odyssey's picture
Update README.md
b757cb4 verified

A newer version of the Gradio SDK is available: 6.1.0

Upgrade
metadata
title: Prompt Image Editor
emoji: 
colorFrom: purple
colorTo: green
sdk: gradio
sdk_version: 6.0.1
app_file: app.py
pinned: false
license: mit

Prompt Image Editor

A clean and flexible Hugging Face Space for generating images from text prompts and editing existing images using mask-based inpainting.
The project is optimized for Spaces and uses Gradio + Diffusers with support for custom model IDs through environment variables.


🔗 Official Links

Note: JumpLander branding is referenced only inside this README.
The source code (app.py) intentionally contains no branding so this Space can be published under a subsidiary account or page.


🚀 Features

  • Text → Image generation
  • Image editing (inpainting) with custom masks
  • Adjustable inference steps
  • Adjustable guidance scale
  • Supports any Diffusers-compatible model through MODEL_ID
  • Clean, fast, GPU-ready

🛠 How to Use (Hugging Face Spaces)

  1. Open your Space.
  2. Go to Settings → Variables & Secrets:
    • Add a Secret:
      • HF_API_TOKEN → Your Hugging Face token (only needed for gated/private models)
    • Add a Variable:
      • MODEL_ID → e.g. runwayml/stable-diffusion-v1-5
  3. Upload:
    • app.py
    • requirements.txt
    • README.md
    • .huggingface.yaml (auto-created from metadata)
  4. Enable GPU if required:
    • Settings → Hardware → GPU

🧪 Recommended Models

You can switch models anytime:

  • runwayml/stable-diffusion-v1-5 (fast & stable)
  • SG161222/RealVisXL2.0 (high-quality realism)
  • stabilityai/sdxl-turbo (very fast)
  • stabilityai/sdxl-base-1.0 (high detail)

Just replace the value of MODEL_ID.


📄 Environment Variables (Spaces)

Name Type Description
MODEL_ID Variable Which diffusion model to load
HF_API_TOKEN Secret Required only for private/gated models

🧰 Project Structure

. ├── app.py # main application ├── requirements.txt # dependencies └── README.md # documentation

yaml Copy code


📘 License

This project is licensed under the MIT License.


🤝 Contribution

Feel free to fork the project, submit improvements, or connect with JumpLander’s community.


Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference