Add model card for INSPATIO-WORLD

README.md

@@ -1,3 +1,59 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+pipeline_tag: image-to-video
+---
+
+# INSPATIO-WORLD: A Real-Time 4D World Simulator via Spatiotemporal Autoregressive Modeling
+
+INSPATIO-WORLD is a real-time framework capable of recovering and generating high-fidelity, dynamic interactive scenes from a single reference video. It utilizes a Spatiotemporal Autoregressive (STAR) architecture to ensure global consistency and precise interaction control.
+
+[[Paper](https://huggingface.co/papers/2604.07209)] [[Project Page](https://inspatio.github.io/inspatio-world/)] [[GitHub](https://github.com/inspatio/inspatio-world)]
+
+## Installation
+
+To set up the environment, follow these steps:
+
+```bash
+conda env create -f environment.yml
+conda activate inspatio_world
+
+# Install flash-attn
+pip install https://github.com/Dao-AILab/flash-attention/releases/download/v2.7.4.post1/flash_attn-2.7.4.post1+cu12torch2.5cxx11abiFALSE-cp310-cp310-linux_x86_64.whl
+```
+
+## Inference
+
+The full pipeline runs in three steps: video captioning, depth estimation, and spatiotemporal autoregressive inference. You can run the full pipeline using the provided script:
+
+### Quick Start
+```bash
+# 1. Place your .mp4 video(s) in a folder
+mkdir -p my_videos
+cp your_video.mp4 my_videos/
+
+# 2. Run the full pipeline (using 14B model)
+bash run_test_pipeline.sh \
+  --input_dir ./my_videos \
+  --traj_txt_path ./traj/x_y_circle_cycle.txt
+```
+
+### Using the 1.3B Model
+For a lighter and faster version, use the 1.3B model:
+```bash
+bash run_test_pipeline.sh \
+  --input_dir ./test/example \
+  --traj_txt_path ./traj/x_y_circle_cycle.txt \
+  --config_path ./configs/inference_1.3b.yaml \
+  --checkpoint_path ./checkpoints/InSpatio-World-1.3B/InSpatio-World-1.3B.safetensors
+```
+
+## Citation
+
+```bibtex
+@misc{inspatio-world,
+    title={InSpatio-World},
+    author={InSpatio Team},
+    howpublished={\url{https://github.com/inspatio/inspatio-world}},
+    year={2026}
+}
+```