faceforge / README.md
Transcendental-Programmer
fix: upgraded gradio version
a8da4e0
|
raw
history blame
2.44 kB
---
title: FaceForge
emoji: πŸ§‘β€πŸŽ¨
colorFrom: indigo
colorTo: pink
sdk: gradio
sdk_version: "4.44.1"
app_file: main.py
pinned: false
---
# faceforge
Interactive latent space editor for face generation using pretrained GANs and diffusion models.
## πŸš€ Deploy on Hugging Face Spaces (Recommended)
FaceForge is ready to run as a Gradio app on [Hugging Face Spaces](https://huggingface.co/spaces):
1. **Push your code to a public GitHub repository.**
2. **Create a new Space** at https://huggingface.co/spaces (choose the Gradio SDK or Docker SDK).
3. **Add your `requirements.txt` and the provided `Dockerfile` to your repo.**
4. **Set the entrypoint to `main.py`** (which handles both the API and UI components).
5. **Deploy!** Your app will be live at `https://<your-username>.hf.space`.
### Example Dockerfile (already included):
```Dockerfile
FROM python:3.10-slim
RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
WORKDIR /app
COPY requirements.txt ./
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
EXPOSE 7860
ENV PYTHONPATH="/app"
ENV PYTHONUNBUFFERED=1
CMD ["python", "main.py"]
```
## Local Development (Optional)
You can still run FaceForge locally:
```bash
pip install -r requirements.txt
python main.py
```
To run in API-only mode:
```bash
FACEFORGE_MODE=api python main.py
```
## Features
- Latent space exploration and manipulation
- Attribute direction discovery (PCA/classifier)
- Custom attribute-preserving loss
- Modular, testable core
- Gradio UI for interactive exploration
## Controls (Gradio UI)
- Enter prompts (comma-separated)
- Choose sampling mode (distance/circle)
- Adjust player position sliders
- Click "Generate" to see results
## Testing
Run all tests with:
```bash
pytest tests/
```
## Debugging
If you encounter Gradio schema-related errors like:
```
TypeError: argument of type 'bool' is not iterable
```
The application includes a patch that should fix the issue automatically. This patch addresses a known issue with schema processing in older Gradio versions.
Recommended steps to diagnose UI issues:
1. Check the logs for detailed error information
2. Ensure you're using Gradio version 4.44.1 or newer (`pip install --upgrade gradio==4.44.1`)
3. Try running in API-only mode to isolate the issue
## Notes
- The backend and frontend are fully integrated for Spaces.
- For custom model integration, edit the core and backend modules as needed.