README

README.md

@@ -1,3 +1,49 @@
 ---
 license: apache-2.0
+language:
+  - en
+tags:
+- cogvideox
+- video-generation
+- image-to-video
+- diffusers
 ---
+
+# cogvideox-2b-img2vid
+
+### How to
+Clone repo 
+```bash
+git clone https://github.com/Nim-Video/cogvideox-2b-img2vid.git
+cd cogvideox-2b-img2vid
+```
+  
+Create venv  
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+  
+Install requirements
+```bash
+pip install -r requirements.txt
+```
+  
+### Simple examples
+#### Inference with cli
+```bash
+python -m inference.cli_demo \
+    --video_path "resources/truck.jpg" \
+    --prompt "A truck is driving through a dirt road, showcasing its capability for off-roading." \
+    --model_path NimVideo/cogvideox-2b-img2vid
+```
+
+#### Inference with Gradio
+```bash
+python -m inference.gradio_web_demo \
+    --model_path NimVideo/cogvideox-2b-img2vid
+```
+
+## Acknowledgements
+Original code and models [CogVideoX](https://github.com/THUDM/CogVideo/tree/main).  
+