diff --git a/README.md b/README.md index a8f0631..5cc3572 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,25 @@ rm data/ljubljana.zip - `VerSe` ([**Sekuboyina et al., 2020**](https://pubs.rsna.org/doi/10.1148/ryai.2020190074)) ... --> -## Development (optional) +## Experiments + +To run the experiments in `DiffPose`, run the following scripts (ensure +you have downloaded the data first): + +``` zsh +cd experiments +mkdir checkpoints +srun python diffpose_train.py +srun python diffpose_register.py +``` + +The training and test-time optimization scripts use SLURM to run on all +subjects in parallel: + +- `diffpose_train.py` is configured to run across six A6000 GPUs +- `diffpose_register.py` is configured to run across six 2080 Ti GPUs + +## Development `DiffPose` package, docs, and CI are all built using [`nbdev`](https://nbdev.fast.ai/). To get set up with`nbdev`, install @@ -89,7 +107,9 @@ important ones are ``` zsh nbdev_preview # Render docs locally and inspect in browser -nbdev_prepare # NECESSARY BEFORE PUSHING: builds package, tests notebooks, and builds docs in one step +nbdev_clean # NECESSARY BEFORE PUSHING +nbdev_test # tests notebooks +nbdev_export # builds package and builds docs ``` For more details, follow this [in-depth diff --git a/notebooks/index.ipynb b/notebooks/index.ipynb index 64ddf08..8874ed4 100644 --- a/notebooks/index.ipynb +++ b/notebooks/index.ipynb @@ -78,7 +78,28 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Development (optional)\n", + "## Experiments\n", + "\n", + "To run the experiments in `DiffPose`, run the following scripts (ensure you have downloaded the data first):\n", + "\n", + "```zsh\n", + "cd experiments\n", + "mkdir checkpoints\n", + "srun python diffpose_train.py\n", + "srun python diffpose_register.py\n", + "```\n", + "\n", + "The training and test-time optimization scripts use SLURM to run on all subjects in parallel:\n", + "\n", + "- `diffpose_train.py` is configured to run across six A6000 GPUs\n", + "- `diffpose_register.py` is configured to run across six 2080 Ti GPUs" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Development\n", "\n", "`DiffPose` package, docs, and CI are all built using [`nbdev`](https://nbdev.fast.ai/).\n", "To get set up with`nbdev`, install the following\n", @@ -94,7 +115,9 @@ "\n", "```zsh\n", "nbdev_preview # Render docs locally and inspect in browser\n", - "nbdev_prepare # NECESSARY BEFORE PUSHING: builds package, tests notebooks, and builds docs in one step\n", + "nbdev_clean # NECESSARY BEFORE PUSHING\n", + "nbdev_test # tests notebooks\n", + "nbdev_export # builds package and builds docs\n", "```\n", "\n", "For more details, follow this [in-depth tutorial](https://nbdev.fast.ai/tutorials/tutorial.html)." diff --git a/notebooks/test_time_optimization.gif b/notebooks/test_time_optimization.gif index a964f8d..5832a8c 100644 Binary files a/notebooks/test_time_optimization.gif and b/notebooks/test_time_optimization.gif differ