From 66b1ac4730089d8d7567250d2ce1612f2ad08044 Mon Sep 17 00:00:00 2001 From: Vivek Gopalakrishnan Date: Sun, 29 Oct 2023 15:42:04 -0400 Subject: [PATCH] Update README.md --- README.md | 54 ++++++++++++++++++++++++------------------------------ 1 file changed, 24 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index deb3ca72f..4bcb37e0c 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,6 @@ DiffDRR Most importantly, `DiffDRR` implements DRR synthesis as a PyTorch module, making it interoperable in deep learning pipelines. -- [Installation Guide](#installation-guide) -- [Usage](#usage) -- [Example: Rigid 2D-to-3D registration](#application-6-dof-slice-to-volume-registration) -- [How does `DiffDRR` work?](#how-does-diffdrr-work) -- [Citing `DiffDRR`](#citing-diffdrr) - ## Installation Guide To install `DiffDRR` from PyPI: @@ -37,29 +31,6 @@ conda install pytorch3d -c pytorch3d ``` should work perfectly well. Otherwise, see PyTorch3D's [installation guide](https://github.com/facebookresearch/pytorch3d/blob/main/INSTALL.md). -### Development (optional) - -`DiffDRR` source code, docs, and CI are all built using -[`nbdev`](https://nbdev.fast.ai/). To get set up with `nbdev`, install -the following - -``` zsh -mamba install jupyterlab nbdev -c fastai -c conda-forge -nbdev_install_quarto # To build docs -nbdev_install_hooks # Make notebooks git-friendly -``` - -Running `nbdev_help` will give you the full list of options. The most -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 -``` - -For more details, follow this [in-depth -tutorial](https://nbdev.fast.ai/tutorials/tutorial.html). - ## Usage The following minimal example specifies the geometry of the projectional radiograph imaging system and traces rays through a CT volume: @@ -106,7 +77,7 @@ On a single NVIDIA RTX 2080 Ti GPU, producing such an image takes The full example is available at [`introduction.ipynb`](https://vivekg.dev/DiffDRR/tutorials/introduction.html). -## Application: 6-DoF Slice-to-Volume Registration +## Application: 2D-3D Registration with Gradient Descent We demonstrate the utility of our auto-differentiable DRR generator by solving a 6-DoF registration problem with gradient-based optimization. @@ -124,6 +95,29 @@ optimization runs like this: The full example is available at [`optimizers.ipynb`](https://vivekg.dev/DiffDRR/tutorials/optimizers.html). +## Development (optional) + +`DiffDRR` source code, docs, and CI are all built using +[`nbdev`](https://nbdev.fast.ai/). To get set up with `nbdev`, install +the following + +``` zsh +mamba install jupyterlab nbdev -c fastai -c conda-forge +nbdev_install_quarto # To build docs +nbdev_install_hooks # Make notebooks git-friendly +``` + +Running `nbdev_help` will give you the full list of options. The most +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 +``` + +For more details, follow this [in-depth +tutorial](https://nbdev.fast.ai/tutorials/tutorial.html). + ## How does `DiffDRR` work? `DiffDRR` reformulates Siddon’s method,[^1] the