Yuzhong Zhao1, Yingya Zhang2, Qixiang Ye1, Fang Wan1†
3Institute of Automation, Chinese Academy of Sciences
4Fudan University, 5Nanyang Technological University
- Welcome for PRs to support other models. Please star ⭐ our project and stay tuned.
- [2024/12/27] 🔥 Support FLUX. TeaCache works well for Image Diffusion Models!
- [2024/12/26] 🔥 Support ConsisID. Thanks @SHYuanBest.
- [2024/12/24] 🔥 Support HunyuanVideo.
- [2024/12/19] 🔥 Support CogVideoX.
- [2024/12/06] 🎉 Release the code of TeaCache. Support Open-Sora, Open-Sora-Plan and Latte.
- [2024/11/28] 🎉 Release the paper of TeaCache.
We introduce Timestep Embedding Aware Cache (TeaCache), a training-free caching approach that estimates and leverages the fluctuating differences among model outputs across timesteps, thereby accelerating the inference. For more details and visual results, please visit our project page.
Please refer to TeaCache4HunyuanVideo.
Please refer to TeaCache4ConsisID.
Please refer to TeaCache4FLUX.
Prerequisites:
- Python >= 3.10
- PyTorch >= 1.13 (We recommend to use a >2.0 version)
- CUDA >= 11.6
We strongly recommend using Anaconda to create a new environment (Python >= 3.10) to run our examples:
conda create -n teacache python=3.10 -y
conda activate teacache
Install TeaCache:
git clone https://github.com/LiewFeng/TeaCache
cd TeaCache
pip install -e .
We first generate videos according to VBench's prompts.
And then calculate Vbench, PSNR, LPIPS and SSIM based on the video generated.
- Generate video
cd eval/teacache
python experiments/latte.py
python experiments/opensora.py
python experiments/open_sora_plan.py
python experiments/cogvideox.py
- Calculate Vbench score
# vbench is calculated independently
# get scores for all metrics
python vbench/run_vbench.py --video_path aaa --save_path bbb
# calculate final score
python vbench/cal_vbench.py --score_dir bbb
- Calculate other metrics
# these metrics are calculated compared with original model
# gt video is the video of original model
# generated video is our methods's results
python common_metrics/eval.py --gt_video_dir aa --generated_video_dir bb
This repository is built based on VideoSys, Diffusers, Open-Sora, Open-Sora-Plan, Latte, CogVideoX, HunyuanVideo, ConsisID and FLUX. Thanks for their contributions!
- The majority of this project is released under the Apache 2.0 license as found in the LICENSE file.
- For VideoSys, Diffusers, Open-Sora, Open-Sora-Plan, Latte, CogVideoX, HunyuanVideo, ConsisID and FLUX, please follow thier LICENSE.
- The service is a research preview. Please contact us if you find any potential violations. (liufeng20@mails.ucas.ac.cn)
If you find TeaCache is useful in your research or applications, please consider giving us a star 🌟 and citing it by the following BibTeX entry.
@article{liu2024timestep,
title={Timestep Embedding Tells: It's Time to Cache for Video Diffusion Model},
author={Liu, Feng and Zhang, Shiwei and Wang, Xiaofeng and Wei, Yujie and Qiu, Haonan and Zhao, Yuzhong and Zhang, Yingya and Ye, Qixiang and Wan, Fang},
journal={arXiv preprint arXiv:2411.19108},
year={2024}
}