Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
m-lyon committed Mar 31, 2022
1 parent c9e7b8e commit ae9496b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

![Model Architecture](resources/rcnn_dmri_model.png)

[![PyPI version](https://badge.fury.io/py/dmri-rcnn.svg)](https://badge.fury.io/py/dmri-rcnn)

This project enhances the angular resolution of dMRI data through the use of a Recurrent CNN.

## Installation
`dMRI-RCNN` can be installed by first downloading a release, then install via pip:
`dMRI-RCNN` can be installed by via pip:
```bash
pip install dmri-rcnn
```
Expand All @@ -18,6 +20,7 @@ Listed below are the requirements for this package.
- `numpy`
- `einops`
- `nibabel`
- `tqdm`

## Inference
Once installed, use `run_dmri_rcnn.py` to perform inference of new dMRI volumes. Below lists the data requirements to use the script, and the commandline arguments available for inference.
Expand Down

0 comments on commit ae9496b

Please sign in to comment.