From a83cbc78e0a76bfc88ab7d34f25b459bd791a041 Mon Sep 17 00:00:00 2001 From: Gengshan Yang Date: Wed, 3 Jul 2024 14:07:32 -0400 Subject: [PATCH] add note on iterations to tutorial --- .gitignore | 1 + docs/source/conf.py | 4 +--- docs/source/tutorials/arbitrary_video.rst | 4 ++++ docs/source/tutorials/category_model.rst | 3 +++ docs/source/tutorials/index.rst | 4 ++-- docs/source/tutorials/multi_video_cat.rst | 4 ++++ docs/source/tutorials/single_video_cat.rst | 3 +++ 7 files changed, 18 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 984795d..0942096 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ run-long.sh lab4d.egg-info __pycache__/ *.pth +*.ckpt preprocess/third_party/vcnplus/vcn_rob.pth preprocess/third_party/viewpoint/human.pth diff --git a/docs/source/conf.py b/docs/source/conf.py index 161ec78..0b2b1ae 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,9 +7,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Lab4D" -copyright = ( - "2023, Gengshan Yang, Jeff Tan, Alex Lyons, Neehar Peri, Carnegie Mellon University" -) +copyright = "2023, Gengshan Yang, Jeff Tan, Alex Lyons, Neehar Peri, Deva Ramanan, Carnegie Mellon University" release = "0.0.0" # -- General configuration --------------------------------------------------- diff --git a/docs/source/tutorials/arbitrary_video.rst b/docs/source/tutorials/arbitrary_video.rst index 64e8646..74872b4 100644 --- a/docs/source/tutorials/arbitrary_video.rst +++ b/docs/source/tutorials/arbitrary_video.rst @@ -281,4 +281,8 @@ To export meshes and motion parameters, run:: +.. note:: + + The default setting may produce broken meshes. To get better one as shown above, train for more iterations by adding `--num_rounds 120`. Also see `this `_ for an explanation. + Visit other `tutorials `_. \ No newline at end of file diff --git a/docs/source/tutorials/category_model.rst b/docs/source/tutorials/category_model.rst index a3c6f8f..b067c1c 100644 --- a/docs/source/tutorials/category_model.rst +++ b/docs/source/tutorials/category_model.rst @@ -143,6 +143,9 @@ To export meshes and motion parameters of video 0, run:: +.. note:: + + The default setting may produce broken meshes. To get better one as shown above, train for more iterations by adding `--num_rounds 120`. Also see `this `_ for an explanation. Re-animation ---------------------------- diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst index 6a37e61..bc213e5 100644 --- a/docs/source/tutorials/index.rst +++ b/docs/source/tutorials/index.rst @@ -23,8 +23,8 @@ The tutorials introduce a complete workflow of Lab4D. We'll use the method and d Each of the tutorial can be executed in a couple of ways: - **Custom videos**: This option allows you to train a model on your own videos. -- **Preprocessed data**: This option skips the preprocessing step and train models on the `preprocessed data `_ we provide. -- **Render-only**: This option skips model training and allows you to render the `pre-trained model weights `_ we provide. +- **Preprocessed data**: This option skips the preprocessing step and train models on the `preprocessed data `_ we provided. +- **Render-only**: This option skips model training and allows you to render the `pre-trained model weights `_ we provided. Content diff --git a/docs/source/tutorials/multi_video_cat.rst b/docs/source/tutorials/multi_video_cat.rst index 74a80af..2f7b9d5 100644 --- a/docs/source/tutorials/multi_video_cat.rst +++ b/docs/source/tutorials/multi_video_cat.rst @@ -135,4 +135,8 @@ To export meshes and motion parameters, run:: +.. note:: + + The default setting may produce broken meshes. To get better one as shown above, train for more iterations by adding `--num_rounds 120`. Also see `this `_ for an explanation. + Visit other `tutorials `_. \ No newline at end of file diff --git a/docs/source/tutorials/single_video_cat.rst b/docs/source/tutorials/single_video_cat.rst index 8cd4274..5f54eb4 100644 --- a/docs/source/tutorials/single_video_cat.rst +++ b/docs/source/tutorials/single_video_cat.rst @@ -155,6 +155,9 @@ To export meshes and motion parameters, run:: +.. note:: + + The default setting may produce broken meshes. To get better one as shown above, train for more iterations by adding `--num_rounds 120`. Also see `this `_ for an explanation. Reconstruct the total scene ------------------------------------------------------------