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.
Using a virtual environment (Python venv) is strongly recommended.
FacePoke has been tested with Python 3.10.
pip3 install --upgrade -r requirements.txt
Install frontend dependencies:
bash
1cd client
2bun install
Build the frontend:
bun build ./src/index.tsx --outdir ../public/
Start the backend server:
python app.py
Open http://localhost:8080 in your web browser.
Docker Deployment
Build the Docker image:
docker build -t facepoke .
Run the container:
docker run -p 8080:8080 facepoke
To deploy to Hugging Face Spaces:
Fork the repository on GitHub.
Create a new Space on Hugging Face.
Connect your GitHub repository to the Space.
Configure the Space to use the Docker runtime.
Note: by default Hugging Face runs the main branch, so if you want to push a feature branch you need to do this:
git push <space_repo> <feature_branch>:main -f
Development
The project structure is organized as follows:
app.py: Main backend server handling WebSocket connections.
engine.py: Core logic.
loader.py: Initializes and loads AI models.
client/: Frontend React application.
src/: TypeScript source files.
public/: Static assets and built files.
Increasing the framerate
I am testing various things to increase the framerate.
One project is to only transmit the modified head, instead of the whole image.
Another one is to automatically adapt to the server and network speed.
Contributing
Contributions to FacePoke are welcome! Please read our Contributing Guidelines for details on how to submit pull requests, report issues, or request features.
License
FacePoke is released under the MIT License. See the LICENSE file for details.
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.
Developed with ❤️ by Julian Bilcke at Hugging Face
