Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eigenvivek authored Oct 29, 2023
1 parent dfefecb commit 66b1ac4
Showing 1 changed file with 24 additions and 30 deletions.
54 changes: 24 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 66b1ac4

Please sign in to comment.