DeepReg Demo README Example¶
Note: Please read the DeepReg Demo Disclaimer.
Author¶
DeepReg Development Team (optional corresponding Author Name) or Author Name for external contributor.
Application¶
Briefly describe the clinical application and the need for registration.
Data¶
Describe the source of the dataset. Dataset should be open-accessible.
Instruction¶
Change current directory to the root directory of DeepReg project;
Steps for preparing the data, launch the training and perform evaluation.
Pre-trained model¶
Clearly indicate that the demo uses pre-trained model by default, while give clear instruction how the alternative user-trained model can be used.
Tested DeepReg version¶
Last commit at which demo was tested: commit hash or DeepReg version tag.
Contact¶
Please raise an issue.
Reference¶
Related references in the form of [1] Reference
.