Update README.md

README.md

@@ -1,10 +1,46 @@
 # meshtalk
 
+This repository contains code to run [MeshTalk](https://openaccess.thecvf.com/content/ICCV2021/papers/Richard_MeshTalk_3D_Face_Animation_From_Speech_Using_Cross-Modality_Disentanglement_ICCV_2021_paper.pdf) for face animation from audio. If you use MeshTalk, please cite
+```
+@inproceedings{richard2021meshtalk,
+    author    = {Richard, Alexander and Zollh\"ofer, Michael and Wen, Yandong and de la Torre, Fernando and Sheikh, Yaser},
+    title     = {MeshTalk: 3D Face Animation From Speech Using Cross-Modality Disentanglement},
+    booktitle = {Proceedings of the IEEE/CVF International Conference on Computer Vision (ICCV)},
+    month     = {October},
+    year      = {2021},
+    pages     = {1173-1182}
+}
+```
+
 ## Supplemental Material
 [![Watch the video](https://github.com/facebookresearch/meshtalk/blob/main/supplemental_video.png)](https://research.fb.com/wp-content/uploads/2021/04/mesh_talk.mp4)
 
-## Data/Code
-Will be made available end of October.
+## Running MeshTalk
+
+### Dependencies
+
+```
+ffmpeg
+numpy
+torch         (tested with v1.10.0)
+pytorch3d     (tested with v0.4.0)
+torchaudio    (tested with v0.10.0)
+```
+
+### Animating a Face Mesh from Audio
+
+Download the [pretrained models](https://github.com/facebookresearch/meshtalk/releases/download/pretrained_models_v1.0/pretrained_models.zip) and unzip them.
+Make sure your python path contains the root directory (`export PYTHONPATH=<your_meshtalk_root_directory>`).
+
+Then, run
+```
+python animate_face.py --model_dir <your_pretrained_model_dir> --audio_file <your_speech_snippet.wav> --output <your_output_file.mp4>
+```
+See a description of command line arguments via `python animate_face.py --help`. We provide a neutral face template mesh in `assets/face_template.obj`. Note that the rendered results look slightly different than in the paper and supplemental video because we use a differnt (open source) rendering engine in this repository.
+
+### Training your own MeshTalk version
+
+We are in the process of releasing high-quality 3D face captures of 16 subjects (a subset of the dataset used in this paper). We will link to the dataset here once it is available.
 
 ## License