Cogvideox 5b

🚀 CogVideoX-5B

CogVideoX-5B是一個開源的視頻生成模型，源自清影。它能根據文本描述生成高質量的視頻，具有出色的視覺效果。

🚀 快速開始

本模型支持使用huggingface diffusers庫進行部署，你可以按照以下步驟進行部署。

建議你訪問我們的GitHub，查看相關的提示詞優化和轉換方法，以獲得更好的體驗。

1. 安裝所需依賴

# diffusers>=0.30.1
# transformers>=4.44.2
# accelerate>=0.33.0 (建議從源碼安裝)
# imageio-ffmpeg>=0.5.1
pip install --upgrade transformers accelerate diffusers imageio-ffmpeg 

2. 運行代碼

import torch
from diffusers import CogVideoXPipeline
from diffusers.utils import export_to_video

prompt = "A panda, dressed in a small, red jacket and a tiny hat, sits on a wooden stool in a serene bamboo forest. The panda's fluffy paws strum a miniature acoustic guitar, producing soft, melodic tunes. Nearby, a few other pandas gather, watching curiously and some clapping in rhythm. Sunlight filters through the tall bamboo, casting a gentle glow on the scene. The panda's face is expressive, showing concentration and joy as it plays. The background includes a small, flowing stream and vibrant green foliage, enhancing the peaceful and magical atmosphere of this unique musical performance."

pipe = CogVideoXPipeline.from_pretrained(
    "THUDM/CogVideoX-5b",
    torch_dtype=torch.bfloat16
)

pipe.enable_model_cpu_offload()
pipe.vae.enable_tiling()

video = pipe(
    prompt=prompt,
    num_videos_per_prompt=1,
    num_inference_steps=50,
    num_frames=49,
    guidance_scale=6,
    generator=torch.Generator(device="cuda").manual_seed(42),
).frames[0]

export_to_video(video, "output.mp4", fps=8)

✨ 主要特性

模型介紹

CogVideoX是源自清影的視頻生成模型的開源版本。以下表格展示了我們目前提供的視頻生成模型列表及其基礎信息。

數據說明

• 使用diffusers庫進行測試時，啟用了diffusers庫提供的所有優化。此解決方案尚未在NVIDIA A100 / H100以外的設備上測試實際顯存/內存使用情況。一般來說，該解決方案可適用於所有NVIDIA安培架構及以上的設備。如果禁用優化，顯存使用量將顯著增加，峰值顯存使用量約為表格顯示的3倍。不過，速度將提高3 - 4倍。你可以選擇性地禁用一些優化，包括：

pipe.enable_model_cpu_offload()
pipe.enable_sequential_cpu_offload()
pipe.vae.enable_slicing()
pipe.vae.enable_tiling()

• 進行多GPU推理時，需要禁用enable_model_cpu_offload()優化。
• 使用INT8模型會降低推理速度。這是為了確保顯存較低的GPU能夠正常進行推理，同時保持最小的視頻質量損失，不過推理速度會顯著下降。
• 2B模型使用FP16精度進行訓練，5B模型使用BF16精度進行訓練。建議使用模型訓練時的精度進行推理。
• PytorchAO和Optimum - quanto可用於對文本編碼器、Transformer和VAE模塊進行量化，以降低CogVideoX的內存需求。這使得在免費的T4 Colab或顯存較小的GPU上運行模型成為可能！值得注意的是，TorchAO量化與torch.compile完全兼容，可顯著提高推理速度。FP8精度必須在NVIDIA H100或更高版本的設備上使用，這需要從源碼安裝torch、torchao、diffusers和accelerate Python包。建議使用CUDA 12.4。
• 推理速度測試也使用了上述顯存優化方案。如果不進行顯存優化，推理速度大約提高10%。只有diffusers版本的模型支持量化。
• 模型僅支持英文輸入；其他語言可以在細化過程中通過大模型翻譯成英文。

注意事項

• 使用SAT對SAT版本的模型進行推理和微調。歡迎訪問我們的GitHub獲取更多信息。

💻 使用示例

基礎用法

import torch
from diffusers import CogVideoXPipeline
from diffusers.utils import export_to_video

prompt = "A panda, dressed in a small, red jacket and a tiny hat, sits on a wooden stool in a serene bamboo forest. The panda's fluffy paws strum a miniature acoustic guitar, producing soft, melodic tunes. Nearby, a few other pandas gather, watching curiously and some clapping in rhythm. Sunlight filters through the tall bamboo, casting a gentle glow on the scene. The panda's face is expressive, showing concentration and joy as it plays. The background includes a small, flowing stream and vibrant green foliage, enhancing the peaceful and magical atmosphere of this unique musical performance."

pipe = CogVideoXPipeline.from_pretrained(
    "THUDM/CogVideoX-5b",
    torch_dtype=torch.bfloat16
)

pipe.enable_model_cpu_offload()
pipe.vae.enable_tiling()

video = pipe(
    prompt=prompt,
    num_videos_per_prompt=1,
    num_inference_steps=50,
    num_frames=49,
    guidance_scale=6,
    generator=torch.Generator(device="cuda").manual_seed(42),
).frames[0]

export_to_video(video, "output.mp4", fps=8)

高級用法

# 使用PytorchAO和Optimum - quanto進行量化推理
# 首先，需要從GitHub源碼安裝PytorchAO和PyTorch Nightly。
# 從源碼和Nightly版本安裝僅在下次發佈前需要。

import torch
from diffusers import AutoencoderKLCogVideoX, CogVideoXTransformer3DModel, CogVideoXPipeline
from diffusers.utils import export_to_video
from transformers import T5EncoderModel
from torchao.quantization import quantize_, int8_weight_only, int8_dynamic_activation_int8_weight

quantization = int8_weight_only

text_encoder = T5EncoderModel.from_pretrained("THUDM/CogVideoX-5b", subfolder="text_encoder", torch_dtype=torch.bfloat16)
quantize_(text_encoder, quantization())

transformer = CogVideoXTransformer3DModel.from_pretrained("THUDM/CogVideoX-5b", subfolder="transformer", torch_dtype=torch.bfloat16)
quantize_(transformer, quantization())

vae = AutoencoderKLCogVideoX.from_pretrained("THUDM/CogVideoX-5b", subfolder="vae", torch_dtype=torch.bfloat16)
quantize_(vae, quantization())

# 創建管道並運行推理
pipe = CogVideoXPipeline.from_pretrained(
    "THUDM/CogVideoX-5b",
    text_encoder=text_encoder,
    transformer=transformer,
    vae=vae,
    torch_dtype=torch.bfloat16,
)
pipe.enable_model_cpu_offload()
pipe.vae.enable_tiling()

prompt = "A panda, dressed in a small, red jacket and a tiny hat, sits on a wooden stool in a serene bamboo forest. The panda's fluffy paws strum a miniature acoustic guitar, producing soft, melodic tunes. Nearby, a few other pandas gather, watching curiously and some clapping in rhythm. Sunlight filters through the tall bamboo, casting a gentle glow on the scene. The panda's face is expressive, showing concentration and joy as it plays. The background includes a small, flowing stream and vibrant green foliage, enhancing the peaceful and magical atmosphere of this unique musical performance."

video = pipe(
    prompt=prompt,
    num_videos_per_prompt=1,
    num_inference_steps=50,
    num_frames=49,
    guidance_scale=6,
    generator=torch.Generator(device="cuda").manual_seed(42),
).frames[0]

export_to_video(video, "output.mp4", fps=8)

此外，使用PytorchAO時，可以將模型序列化並存儲為量化數據類型，以節省磁盤空間。可在以下鏈接找到示例和基準測試：

• torchao
• quanto

📚 詳細文檔

歡迎訪問我們的github，你可以在那裡找到：

1. 更詳細的技術細節和代碼解釋。
2. 提示詞的優化和轉換方法。
3. SAT版本模型的推理和微調，甚至預發佈內容。
4. 項目更新日誌動態，更多互動機會。
5. CogVideoX工具鏈，幫助你更好地使用模型。
6. INT8模型推理代碼支持。

📄 許可證

本模型根據CogVideoX許可證發佈。

📜 引用

@article{yang2024cogvideox,
  title={CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer},
  author={Yang, Zhuoyi and Teng, Jiayan and Zheng, Wendi and Ding, Ming and Huang, Shiyu and Xu, Jiazheng and Yang, Yuanming and Hong, Wenyi and Zhang, Xiaohan and Feng, Guanyu and others},
  journal={arXiv preprint arXiv:2408.06072},
  year={2024}
}

🔍 演示展示

📄 中文閱讀 | 🤗 Huggingface Space | 🌐 Github | 📜 arxiv

📍 訪問 清影 和 API平臺 體驗商業視頻生成模型。