Spaces:
Paused
Paused
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,146 +1,13 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: yellow
|
| 5 |
colorTo: red
|
| 6 |
-
sdk:
|
| 7 |
pinned: true
|
| 8 |
license: mit
|
| 9 |
header: mini
|
| 10 |
-
app_file:
|
| 11 |
-
app_port: 8080
|
| 12 |
disable_embedding: true
|
| 13 |
-
short_description:
|
| 14 |
---
|
| 15 |
-
|
| 16 |
-
# FacePoke
|
| 17 |
-
|
| 18 |
-
## Table of Contents
|
| 19 |
-
|
| 20 |
-
- [Introduction](#introduction)
|
| 21 |
-
- [Acknowledgements](#acknowledgements)
|
| 22 |
-
- [Installation](#installation)
|
| 23 |
-
- [Local Setup](#local-setup)
|
| 24 |
-
- [Docker Deployment](#docker-deployment)
|
| 25 |
-
- [Development](#development)
|
| 26 |
-
- [Contributing](#contributing)
|
| 27 |
-
- [License](#license)
|
| 28 |
-
|
| 29 |
-
## Introduction
|
| 30 |
-
|
| 31 |
-
A real-time head transformation app.
|
| 32 |
-
|
| 33 |
-
For best performance please run the app from your own machine (local or in the cloud).
|
| 34 |
-
|
| 35 |
-
**Repository**: [GitHub - jbilcke-hf/FacePoke](https://github.com/jbilcke-hf/FacePoke)
|
| 36 |
-
|
| 37 |
-
You can try the demo but it is a shared space, latency may be high if there are multiple users or if you live far from the datacenter hosting the Hugging Face Space.
|
| 38 |
-
|
| 39 |
-
**Live Demo**: [FacePoke on Hugging Face Spaces](https://huggingface.co/spaces/jbilcke-hf/FacePoke)
|
| 40 |
-
|
| 41 |
-
## Acknowledgements
|
| 42 |
-
|
| 43 |
-
This project is based on LivePortrait: https://arxiv.org/abs/2407.03168
|
| 44 |
-
|
| 45 |
-
It uses the face transformation routines from https://github.com/PowerHouseMan/ComfyUI-AdvancedLivePortrait
|
| 46 |
-
|
| 47 |
-
## Installation
|
| 48 |
-
|
| 49 |
-
### Before you install
|
| 50 |
-
|
| 51 |
-
FacePoke has only been tested in a Linux environment, using `Python 3.10` and `CUDA 12.4` (so a NVIDIA GPU).
|
| 52 |
-
|
| 53 |
-
Contributions are welcome to help supporting other platforms!
|
| 54 |
-
|
| 55 |
-
### Local Setup
|
| 56 |
-
|
| 57 |
-
1. Make sure you have Git and Git LFS installed globally (https://git-lfs.com):
|
| 58 |
-
|
| 59 |
-
```bash
|
| 60 |
-
git lfs install
|
| 61 |
-
```
|
| 62 |
-
|
| 63 |
-
2. Clone the repository:
|
| 64 |
-
```bash
|
| 65 |
-
git clone https://github.com/jbilcke-hf/FacePoke.git
|
| 66 |
-
cd FacePoke
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
3. Install Python dependencies:
|
| 70 |
-
|
| 71 |
-
Using a virtual environment (Python venv) is strongly recommended.
|
| 72 |
-
|
| 73 |
-
FacePoke has been tested with `Python 3.10`.
|
| 74 |
-
|
| 75 |
-
```bash
|
| 76 |
-
pip3 install --upgrade -r requirements.txt
|
| 77 |
-
```
|
| 78 |
-
|
| 79 |
-
4. Install frontend dependencies:
|
| 80 |
-
```bash
|
| 81 |
-
cd client
|
| 82 |
-
bun install
|
| 83 |
-
```
|
| 84 |
-
|
| 85 |
-
5. Build the frontend:
|
| 86 |
-
```bash
|
| 87 |
-
bun build ./src/index.tsx --outdir ../public/
|
| 88 |
-
```
|
| 89 |
-
|
| 90 |
-
6. Start the backend server:
|
| 91 |
-
```bash
|
| 92 |
-
python app.py
|
| 93 |
-
```
|
| 94 |
-
|
| 95 |
-
7. Open `http://localhost:8080` in your web browser.
|
| 96 |
-
|
| 97 |
-
### Docker Deployment
|
| 98 |
-
|
| 99 |
-
1. Build the Docker image:
|
| 100 |
-
```bash
|
| 101 |
-
docker build -t facepoke .
|
| 102 |
-
```
|
| 103 |
-
|
| 104 |
-
2. Run the container:
|
| 105 |
-
```bash
|
| 106 |
-
docker run -p 8080:8080 facepoke
|
| 107 |
-
```
|
| 108 |
-
|
| 109 |
-
3. To deploy to Hugging Face Spaces:
|
| 110 |
-
- Fork the repository on GitHub.
|
| 111 |
-
- Create a new Space on Hugging Face.
|
| 112 |
-
- Connect your GitHub repository to the Space.
|
| 113 |
-
- Configure the Space to use the Docker runtime.
|
| 114 |
-
|
| 115 |
-
## Development
|
| 116 |
-
|
| 117 |
-
The project structure is organized as follows:
|
| 118 |
-
|
| 119 |
-
- `app.py`: Main backend server handling WebSocket connections.
|
| 120 |
-
- `engine.py`: Core logic.
|
| 121 |
-
- `loader.py`: Initializes and loads AI models.
|
| 122 |
-
- `client/`: Frontend React application.
|
| 123 |
-
- `src/`: TypeScript source files.
|
| 124 |
-
- `public/`: Static assets and built files.
|
| 125 |
-
|
| 126 |
-
### Increasing the framerate
|
| 127 |
-
|
| 128 |
-
I am testing various things to increase the framerate.
|
| 129 |
-
|
| 130 |
-
One project is to only transmit the modified head, instead of the whole image.
|
| 131 |
-
|
| 132 |
-
Another one is to automatically adapt to the server and network speed.
|
| 133 |
-
|
| 134 |
-
## Contributing
|
| 135 |
-
|
| 136 |
-
Contributions to FacePoke are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on how to submit pull requests, report issues, or request features.
|
| 137 |
-
|
| 138 |
-
## License
|
| 139 |
-
|
| 140 |
-
FacePoke is released under the MIT License. See the [LICENSE](LICENSE) file for details.
|
| 141 |
-
|
| 142 |
-
Please note that while the code of LivePortrait and Insightface are open-source with "no limitation for both academic and commercial usage", the model weights trained from Insightface data are available for [non-commercial research purposes only](https://github.com/deepinsight/insightface?tab=readme-ov-file#license).
|
| 143 |
-
|
| 144 |
-
---
|
| 145 |
-
|
| 146 |
-
Developed with ❤️ by Julian Bilcke at Hugging Face
|
|
|
|
| 1 |
---
|
| 2 |
+
title: ShutUp
|
| 3 |
+
emoji: 🫢
|
| 4 |
colorFrom: yellow
|
| 5 |
colorTo: red
|
| 6 |
+
sdk: gradio
|
| 7 |
pinned: true
|
| 8 |
license: mit
|
| 9 |
header: mini
|
| 10 |
+
app_file: gradio.py
|
|
|
|
| 11 |
disable_embedding: true
|
| 12 |
+
short_description: Dont Scream 🫢!
|
| 13 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|