软件包
文档
代码
论文

DeepReg

DeepReg是一个免费提供、由社区支持的开源工具包，用于基于深度学习的医学图像配准研究与教育。

• 基于TensorFlow 2，训练高效且部署迅速；
• 实现了主要的无监督和弱监督算法，以及它们的组合与变体；
• 专注于不断增长且多样化的临床应用，所有DeepReg演示均使用公开可用的数据；
• 内置简单命令行工具，只需最少的编程和脚本编写；
• 开放、宽松且以研究和教育为导向，遵循Apache 2.0许可协议。

---

入门指南

• DeepReg.Net
• 文档、教程和快速入门
• 使用DeepReg的医学图像配准演示
• 问题追踪器

贡献说明

欢迎参与，帮助我们共同改进DeepReg！我们非常需要您的帮助——真的。

成为贡献者并不只是编写代码。 对于开源项目而言，撰写或校对文档、提出或实施测试方案，以及对项目提供反馈同样重要。您可能会发现那些被忽略的错误和假设。只要您会写一点代码，就可以为开源项目做出贡献。我们一直在尝试新技能、犯错，并从这些错误中学习。正是这样，我们才能不断进步，我们也乐于帮助他人与我们一起成长。

行为准则

本项目遵循一份 行为准则。 参与本项目即表示您同意遵守其中的各项条款。

我应该从哪里开始？

有关如何为DeepReg做出贡献的指导，请参阅我们的 贡献指南。

如果您有一个使用公开数据的配准应用，不妨考虑 提交一个DeepReg演示。

MICCAI 2020教育挑战赛

我们在MICCAI教育挑战赛中的 DeepReg提交作品荣获奖项！

请在此处查看： https://github.com/DeepRegNet/DeepReg/blob/main/docs/Intro_to_Medical_Image_Registration.ipynb - 您也可以通过 直接运行。

概览视频

2020年11月4日，DeepReg开发团队成员在伦敦大学学院医学影像计算中心（CMIC）的系列研讨会上发表了题为“通往DeepReg之路”的报告。您可以在这里观看该演讲： https://www.youtube.com/watch?v=jDEyWXZM3CE&feature=youtu.be。

引用 DeepReg

DeepReg 是一款研究型软件，由一支 学术研究团队 开发。对我们的软件进行引用和使用，有助于我们证明为维护和发展该项目所付出的努力是值得的，并将继续投入。

如果您在研究中使用了 DeepReg，请考虑引用我们：

Fu et al., (2020). DeepReg：用于医学图像配准的深度学习工具包。 开源软件期刊，5(55), 2705， https://doi.org/10.21105/joss.02705

或使用 BibTeX 格式：

@article{Fu2020,
  doi = {10.21105/joss.02705},
  url = {https://doi.org/10.21105/joss.02705},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {55},
  pages = {2705},
  author = {Yunguan Fu and Nina Montaña Brown and Shaheer U. Saeed and Adrià Casamitjana and Zachary M. C. Baum and Rémi Delaunay and Qianye Yang and Alexander Grimwood and Zhe Min and Stefano B. Blumberg and Juan Eugenio Iglesias and Dean C. Barratt and Ester Bonmati and Daniel C. Alexander and Matthew J. Clarkson and Tom Vercauteren and Yipeng Hu},
  title = {DeepReg: a deep learning toolkit for medical image registration},
  journal = {Journal of Open Source Software}
}

DeepReg 快速上手指南

DeepReg 是一个基于 TensorFlow 2 的开源深度学习工具包，专为医学图像配准的研究与教育设计。它提供了无监督和弱监督算法的实现，并内置了简单的命令行工具，无需复杂的编程即可使用。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python 版本：建议 Python 3.7 及以上版本（具体兼容版本请参考 PyPI 页面标识）
• 前置依赖：
  • pip 包管理工具
  • （可选但推荐）GPU 支持：若需加速训练，请预先安装 compatible 版本的 CUDA 和 cuDNN，以及对应的 tensorflow-gpu 或包含 GPU 支持的 TensorFlow。

安装步骤

推荐使用 pip 进行安装。您可以选择稳定版或直接从源码安装最新版。

方法一：通过 PyPI 安装（推荐）

pip install deepreg

提示：如果您在中国大陆，遇到下载速度慢的问题，可以使用国内镜像源加速：

pip install deepreg -i https://pypi.tuna.tsinghua.edu.cn/simple

方法二：从源码安装（适合开发者）

如果您希望获取最新功能或参与贡献，可以从 GitHub 克隆仓库并安装：

git clone https://github.com/DeepRegNet/DeepReg.git
cd DeepReg
pip install -e .

基本使用

DeepReg 提供了内置的命令行工具，使得运行演示和训练模型变得非常简单。以下是最基础的使用流程。

1. 验证安装

安装完成后，您可以在终端输入以下命令检查是否安装成功：

deepreg --help

2. 运行官方演示 (Demo)

DeepReg 包含了多个使用公开数据集的配准演示。以运行一个基础的无监督配准 Demo 为例：

# 下载并运行 demo (具体 demo 名称请参考文档，此处以通用命令结构为例)
deepreg_demo --config_path path/to/config.yaml

注：具体的配置文件路径和参数取决于您选择的特定 Demo（如脑部 MRI、腹部 CT 等）。建议先浏览 DeepReg Demos 获取特定任务的配置示例。

3. 自定义训练与预测

对于自定义数据，您需要准备符合 DeepReg 格式的数据集，并编写 YAML 配置文件。基本训练命令如下：

# 训练模型
deepreg_train --config_path config/train.yaml --log_dir logs/my_experiment

# 使用训练好的模型进行预测
deepreg_predict --config_path config/predict.yaml --ckpt_path logs/my_experiment/save/weights-epoch_XX.ckpt

更多详细的配置选项、数据格式要求及高级用法，请参阅 官方文档。