ai-clip-factory / README.md
jbilcke-hf's picture
jbilcke-hf HF staff
clean-up and preparation work for oauth (maybe)
62c3e75
---
title: AI Clip Factory
emoji: 🧞
colorFrom: yellow
colorTo: purple
sdk: docker
pinned: true
app_port: 3000
disable_embedding: true
hf_oauth_redirect_path: /api/oauth/callback
---
# The AI Clip Factory
The AI Clip Factory is a space to create animated videos in an ultra simple and fun way. It is meant to be a child's play.
## Text-to-video model
The AI Clip Factory is a space about clip generation and providing a fun UI, and is not meant to promote a specific AI model.
As a consequence, a model currently defined as default may be replaced at anytime by a newer SOTA model.
Right now (2023-10-19) the default model is the base Hotshot-XL (use the official website for faster inference at [https://hotshot.co](https://hotshot.co)).
# Interpolation model
The default model used for interpolation is [ST-MFNet](https://github.com/zsxkib/ST-MFNet)
## Setup
If you run the app locally you need to create a `.env.local` file
(If you deploy to Hugging Face, just set the environment variable from the settings)
### Video rendering engine
Note: the app is in heavy development, not all backends are supported
Set `VIDEO_ENGINE` to one of:
- `VIDEO_ENGINE="VIDEO_HOTSHOT_XL_API_GRADIO"`
- `VIDEO_ENGINE="VIDEO_HOTSHOT_XL_API_REPLICATE"`
- `VIDEO_ENGINE="VIDEO_HOTSHOT_XL_API_NODE"` <- not working yet
- `VIDEO_ENGINE="VIDEO_HOTSHOT_XL_API_OFFICIAL"` <- not working yet
### Authentication
If you intent to use a special provider (eg. Replicate) you need to setup your token
- `AUTH_REPLICATE_API_TOKEN="<YOUR SECRET>"`