Upload folder using huggingface_hub

README.md

@@ -1,207 +1,212 @@
----
-'[object Object]': null
-license: mit
-datasets:
-- allenai/objaverse
-language:
-- en
-pipeline_tag: text-to-video
-tags:
-- video diffusion
-- text-to-video
----
+# AnimateDiff
+
+This repository is the official implementation of [AnimateDiff](https://arxiv.org/abs/2307.04725).
+
+**[AnimateDiff: Animate Your Personalized Text-to-Image Diffusion Models without Specific Tuning](https://arxiv.org/abs/2307.04725)**
+</br>
+Yuwei Guo,
+Ceyuan Yang*,
+Anyi Rao,
+Yaohui Wang,
+Yu Qiao,
+Dahua Lin,
+Bo Dai
+<p style="font-size: 0.8em; margin-top: -1em">*Corresponding Author</p>
+
+<!-- [Arxiv Report](https://arxiv.org/abs/2307.04725) | [Project Page](https://animatediff.github.io/) -->
+[![arXiv](https://img.shields.io/badge/arXiv-2307.04725-b31b1b.svg)](https://arxiv.org/abs/2307.04725)
+[![Project Page](https://img.shields.io/badge/Project-Website-green)](https://animatediff.github.io/)
+[![Open in OpenXLab](https://cdn-static.openxlab.org.cn/app-center/openxlab_app.svg)](https://openxlab.org.cn/apps/detail/Masbfca/AnimateDiff)
+[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-yellow)](https://huggingface.co/spaces/guoyww/AnimateDiff)
+
+## Next
+One with better controllability and quality is coming soon. Stay tuned.
+
+## Features
+- **[2023/11/10]** Release the Motion Module (beta version) on SDXL, available at [Google Drive](https://drive.google.com/file/d/1EK_D9hDOPfJdK4z8YDB8JYvPracNx2SX/view?usp=share_link
+) / [HuggingFace](https://huggingface.co/guoyww/animatediff/blob/main/mm_sdxl_v10_beta.ckpt
+) / [CivitAI](https://civitai.com/models/108836/animatediff-motion-modules). High resolution videos (i.e., 1024x1024x16 frames with various aspect ratios) could be produced **with/without** personalized models. Inference usually requires ~13GB VRAM and tuned hyperparameters (e.g., #sampling steps), depending on the chosen personalized models. Checkout to the branch [sdxl](https://github.com/guoyww/AnimateDiff/tree/sdxl) for more details of the inference. More checkpoints with better-quality would be available soon. Stay tuned. Examples below are manually downsampled for fast loading.
+
+  <table class="center">
+     <tr style="line-height: 0">
+      <td width=50% style="border: none; text-align: center">Original SDXL</td>
+      <td width=30% style="border: none; text-align: center">Personalized SDXL</td>
+      <td width=20% style="border: none; text-align: center">Personalized SDXL</td>
+      </tr>
+      <tr>
+      <td width=50% style="border: none"><img src="__assets__/animations/motion_xl/01.gif"></td>
+      <td width=30% style="border: none"><img src="__assets__/animations/motion_xl/02.gif"></td>
+      <td width=20% style="border: none"><img src="__assets__/animations/motion_xl/03.gif"></td>
+      </tr>
+  </table>
+
+
+
+- **[2023/09/25]** Release **MotionLoRA** and its model zoo, **enabling camera movement controls**! Please download the MotionLoRA models (**74 MB per model**, available at [Google Drive](https://drive.google.com/drive/folders/1EqLC65eR1-W-sGD0Im7fkED6c8GkiNFI?usp=sharing) / [HuggingFace](https://huggingface.co/guoyww/animatediff) / [CivitAI](https://civitai.com/models/108836/animatediff-motion-modules) ) and save them to the `models/MotionLoRA` folder. Example:
+  ```
+  python -m scripts.animate --config configs/prompts/v2/5-RealisticVision-MotionLoRA.yaml
+  ```
+    <table class="center">
+      <tr style="line-height: 0">
+      <td colspan="2" style="border: none; text-align: center">Zoom In</td>
+      <td colspan="2" style="border: none; text-align: center">Zoom Out</td>
+      <td colspan="2" style="border: none; text-align: center">Zoom Pan Left</td>
+      <td colspan="2" style="border: none; text-align: center">Zoom Pan Right</td>
+      </tr>
+      <tr>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/01.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/02.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/02.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/01.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/03.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/04.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/04.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/03.gif"></td>
+      </tr>
+      <tr style="line-height: 0">
+      <td colspan="2" style="border: none; text-align: center">Tilt Up</td>
+      <td colspan="2" style="border: none; text-align: center">Tilt Down</td>
+      <td colspan="2" style="border: none; text-align: center">Rolling Anti-Clockwise</td>
+      <td colspan="2" style="border: none; text-align: center">Rolling Clockwise</td>
+      </tr>
+      <tr>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/05.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/05.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/06.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/06.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/07.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/07.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_01/08.gif"></td>
+      <td style="border: none"><img src="__assets__/animations/motion_lora/model_02/08.gif"></td>
+      </tr>
+  </table>
+
+- **[2023/09/10]** New Motion Module release! `mm_sd_v15_v2.ckpt` was trained on larger resolution & batch size, and gains noticeable quality improvements. Check it out at [Google Drive](https://drive.google.com/drive/folders/1EqLC65eR1-W-sGD0Im7fkED6c8GkiNFI?usp=sharing) / [HuggingFace](https://huggingface.co/guoyww/animatediff) / [CivitAI](https://civitai.com/models/108836/animatediff-motion-modules) and use it with `configs/inference/inference-v2.yaml`. Example:
+  ```
+  python -m scripts.animate --config configs/prompts/v2/5-RealisticVision.yaml
+  ```
+  Here is a qualitative comparison between `mm_sd_v15.ckpt` (left) and `mm_sd_v15_v2.ckpt` (right):
+  <table class="center">
+      <tr>
+      <td><img src="__assets__/animations/compare/old_0.gif"></td>
+      <td><img src="__assets__/animations/compare/new_0.gif"></td>
+      <td><img src="__assets__/animations/compare/old_1.gif"></td>
+      <td><img src="__assets__/animations/compare/new_1.gif"></td>
+      <td><img src="__assets__/animations/compare/old_2.gif"></td>
+      <td><img src="__assets__/animations/compare/new_2.gif"></td>
+      <td><img src="__assets__/animations/compare/old_3.gif"></td>
+      <td><img src="__assets__/animations/compare/new_3.gif"></td>
+      </tr>
+  </table>
+- GPU Memory Optimization, ~12GB VRAM to inference
+
+
+## Quick Demo
+
+User Interface developed by community: 
+  - A1111 Extension [sd-webui-animatediff](https://github.com/continue-revolution/sd-webui-animatediff) (by [@continue-revolution](https://github.com/continue-revolution))
+  - ComfyUI Extension [ComfyUI-AnimateDiff-Evolved](https://github.com/Kosinkadink/ComfyUI-AnimateDiff-Evolved) (by [@Kosinkadink](https://github.com/Kosinkadink))
+  - Google Colab: [Colab](https://colab.research.google.com/github/camenduru/AnimateDiff-colab/blob/main/AnimateDiff_colab.ipynb) (by [@camenduru](https://github.com/camenduru))
+
+We also create a Gradio demo to make AnimateDiff easier to use. To launch the demo, please run the following commands:
+```
+conda activate animatediff
+python app.py
+```
+By default, the demo will run at `localhost:7860`.
+<br><img src="__assets__/figs/gradio.jpg" style="width: 50em; margin-top: 1em">
+
+
+## Model Zoo
+<details open>
+<summary>Motion Modules</summary>
+
+  | Name                 | Parameter | Storage Space |
+  |----------------------|-----------|---------------|
+  | mm_sd_v14.ckpt       | 417 M     | 1.6 GB        |
+  | mm_sd_v15.ckpt       | 417 M     | 1.6 GB        |
+  | mm_sd_v15_v2.ckpt    | 453 M     | 1.7 GB        |
+
+</details>
+
+<details open>
+<summary>MotionLoRAs</summary>
+
+  | Name                                 | Parameter | Storage Space |
+  |--------------------------------------|-----------|---------------|
+  | v2_lora_ZoomIn.ckpt                  | 19 M      | 74 MB         |
+  | v2_lora_ZoomOut.ckpt                 | 19 M      | 74 MB         |
+  | v2_lora_PanLeft.ckpt                 | 19 M      | 74 MB         |
+  | v2_lora_PanRight.ckpt                | 19 M      | 74 MB         |
+  | v2_lora_TiltUp.ckpt                   | 19 M      | 74 MB         |
+  | v2_lora_TiltDown.ckpt                 | 19 M      | 74 MB         |
+  | v2_lora_RollingClockwise.ckpt        | 19 M      | 74 MB         |
+  | v2_lora_RollingAnticlockwise.ckpt    | 19 M      | 74 MB         |
+
+</details>
+
+## Common Issues
+<details>
+<summary>Installation</summary>
+
+Please ensure the installation of [xformer](https://github.com/facebookresearch/xformers) that is applied to reduce the inference memory.
+</details>
+
+
+<details>
+<summary>Various resolution or number of frames</summary>
+Currently, we recommend users to generate animation with 16 frames and 512 resolution that are aligned with our training settings. Notably, various resolution/frames may affect the quality more or less. 
+</details>
+
+
+<details>
+<summary>How to use it without any coding</summary>
+
+1) Get lora models: train lora model with [A1111](https://github.com/continue-revolution/sd-webui-animatediff) based on a collection of your own favorite images (e.g., tutorials [English](https://www.youtube.com/watch?v=mfaqqL5yOO4), [Japanese](https://www.youtube.com/watch?v=N1tXVR9lplM), [Chinese](https://www.bilibili.com/video/BV1fs4y1x7p2/)) 
+or download Lora models from [Civitai](https://civitai.com/).
+
+2) Animate lora models: using gradio interface or A1111 
+(e.g., tutorials [English](https://github.com/continue-revolution/sd-webui-animatediff), [Japanese](https://www.youtube.com/watch?v=zss3xbtvOWw), [Chinese](https://941ai.com/sd-animatediff-webui-1203.html)) 
+
+3) Be creative togther with other techniques, such as, super resolution, frame interpolation, music generation, etc.
+</details>
+
+
+<details>
+<summary>Animating a given image</summary>
+
+We totally agree that animating a given image is an appealing feature, which we would try to support officially in future. For now, you may enjoy other efforts from the [talesofai](https://github.com/talesofai/AnimateDiff).  
+</details>
+
+<details>
+<summary>Contributions from community</summary>
+Contributions are always welcome!! The <code>dev</code> branch is for community contributions. As for the main branch, we would like to align it with the original technical report :)
+</details>
+
+## Training and inference
+Please refer to [ANIMATEDIFF](./__assets__/docs/animatediff.md) for the detailed setup.
 
-# Model Card for {{ model_id | default("Model ID", true) }}
+## Gallery
+We collect several generated results in [GALLERY](./__assets__/docs/gallery.md).
 
-<!-- Provide a quick summary of what the model is/does. -->
+## BibTeX
+```
+@article{guo2023animatediff,
+  title={AnimateDiff: Animate Your Personalized Text-to-Image Diffusion Models without Specific Tuning},
+  author={Guo, Yuwei and Yang, Ceyuan and Rao, Anyi and Wang, Yaohui and Qiao, Yu and Lin, Dahua and Dai, Bo},
+  journal={arXiv preprint arXiv:2307.04725},
+  year={2023}
+}
+```
 
-{{ model_summary | default("", true) }}
+## Disclaimer
+This project is released for academic use. We disclaim responsibility for user-generated content. Users are solely liable for their actions. The project contributors are not legally affiliated with, nor accountable for, users' behaviors. Use the generative model responsibly, adhering to ethical and legal standards.
 
-## Model Details
 
-### Model Description
+## Contact Us
+**Yuwei Guo**: [guoyuwei@pjlab.org.cn](mailto:guoyuwei@pjlab.org.cn)  
+**Ceyuan Yang**: [yangceyuan@pjlab.org.cn](mailto:yangceyuan@pjlab.org.cn)  
+**Bo Dai**: [daibo@pjlab.org.cn](mailto:daibo@pjlab.org.cn)
 
-<!-- Provide a longer summary of what this model is. -->
-
-{{ model_description | default("", true) }}
-
-- **Developed by:** {{ developers | default("[More Information Needed]", true)}}
-- **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
-- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
-- **Model type:** {{ model_type | default("[More Information Needed]", true)}}
-- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
-- **License:** {{ license | default("[More Information Needed]", true)}}
-- **Finetuned from model [optional]:** {{ base_model | default("[More Information Needed]", true)}}
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** {{ repo | default("[More Information Needed]", true)}}
-- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
-- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-{{ direct_use | default("[More Information Needed]", true)}}
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-{{ downstream_use | default("[More Information Needed]", true)}}
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-{{ out_of_scope_use | default("[More Information Needed]", true)}}
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-{{ bias_risks_limitations | default("[More Information Needed]", true)}}
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-{{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.", true)}}
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-{{ get_started_code | default("[More Information Needed]", true)}}
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-{{ training_data | default("[More Information Needed]", true)}}
-
-### Training Procedure 
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-{{ preprocessing | default("[More Information Needed]", true)}}
-
-
-#### Training Hyperparameters
-
-- **Training regime:** {{ training_regime | default("[More Information Needed]", true)}} <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-{{ speeds_sizes_times | default("[More Information Needed]", true)}}
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-{{ testing_data | default("[More Information Needed]", true)}}
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-{{ testing_factors | default("[More Information Needed]", true)}}
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-{{ testing_metrics | default("[More Information Needed]", true)}}
-
-### Results
-
-{{ results | default("[More Information Needed]", true)}}
-
-#### Summary
-
-{{ results_summary | default("", true) }}
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-{{ model_examination | default("[More Information Needed]", true)}}
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** {{ hardware_type | default("[More Information Needed]", true)}}
-- **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
-- **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
-- **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
-- **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-{{ model_specs | default("[More Information Needed]", true)}}
-
-### Compute Infrastructure
-
-{{ compute_infrastructure | default("[More Information Needed]", true)}}
-
-#### Hardware
-
-{{ hardware_requirements | default("[More Information Needed]", true)}}
-
-#### Software
-
-{{ software | default("[More Information Needed]", true)}}
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-{{ citation_bibtex | default("[More Information Needed]", true)}}
-
-**APA:**
-
-{{ citation_apa | default("[More Information Needed]", true)}}
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-{{ glossary | default("[More Information Needed]", true)}}
-
-## More Information [optional]
-
-{{ more_information | default("[More Information Needed]", true)}}
-
-## Model Card Authors [optional]
-
-{{ model_card_authors | default("[More Information Needed]", true)}}
-
-## Model Card Contact
-
-{{ model_card_contact | default("[More Information Needed]", true)}}
+## Acknowledgements
+Codebase built upon [Tune-a-Video](https://github.com/showlab/Tune-A-Video).

inference.py

@@ -0,0 +1,17 @@
+# this is the huggingface inference script for the animation pipeline
+# it takes in a text prompt and generates an animation based on the text
+
+import os
+import sys
+import json
+import torch
+import argparse
+import numpy as np
+from PIL import Image
+from tqdm import tqdm
+
+import torch.nn.functional as F
+from torch.utils.data import DataLoader
+from torchvision import transforms
+from torchvision.utils import save_image
+

models/Motion_Module/test/inv_latents/ddim_latent-1.pt

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6bb60d23d5501d2b6651bbdddf6b9366da7e360763851e2a0466defedd486a4e
+oid sha256:1ff819827be55caa5766985bd0b2b103cd0d1e3a4699c85ac79ec8df63292b40
 size 41725

models/Motion_Module/test/mm.pth

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:f02d7a609ddb3b9909d32d246da8b1c61016fef19320a9f1192fb88a29e49c34
+oid sha256:b55d872dc4d51093464540fc2d0be3cede056409ae1f76ce002d5fd83f2f05c3
 size 1672103655