医学影像深度学习工具包（DLTK）

DLTK 是一个基于 TensorFlow 的 Python 深度学习工具包。它旨在为图像分析应用提供快速原型开发的能力，降低入门门槛，并确保结果的可重复性，尤其专注于医学影像领域。其目标是向社区提供最先进的方法和模型，从而加速这一充满活力的研究领域的进展。

文档

DLTK 的 API 文档可以在这里找到：DLTK 文档

引用 DLTK

如果您在工作中使用了 DLTK，请参考以下当前版本的引用：

@article{pawlowski2017state,
  title={DLTK: State of the Art Reference Implementations for Deep Learning on Medical Images},
  author={Nick Pawlowski and S. Ira Ktena, and Matthew C.H. Lee and Bernhard Kainz and Daniel Rueckert and Ben Glocker and Martin Rajchl},
  journal={arXiv preprint arXiv:1711.06853},
  year={2017}
}

如果您使用了 DLTK Model Zoo 中的任何应用，请同时参考相应应用文件夹中的 README.md 文件，以遵守其作者关于引用的具体说明。

生物医学图像分析简介

为了帮助您更好地入门，我们为新的 TensorFlow 博客 撰写了简短的概述文章 博客文章（阅读时间约 12 分钟）。文章涵盖了处理医学图像所需的一些专业知识，如果您是该领域的初学者，建议先阅读这篇文章。文中提到的代码可以在 examples/tutorials 和 examples/applications 目录中找到。

安装

1. 设置并激活虚拟环境。尽管 DLTK <= 0.2.1 支持 Python 2.7，但我们后续版本将不再支持该版本，这与我们的依赖库（如 SciPy、NumPy）保持一致。强烈建议使用 Python 3。如果您打算在不同系统版本的机器上运行此项目，请使用 --always-copy 标志：

   virtualenv -p python3 --always-copy venv_tf
   source venv_tf/bin/activate
   

2. 根据您的系统安装 TensorFlow（>=1.4.0，推荐带 GPU 支持），具体步骤请参阅 此处：

   pip install "tensorflow-gpu>=1.4.0"
   

3. 安装 DLTK： 您有两种安装方式可供选择：可以直接从 PyPI 安装 dltk：

   pip install dltk
   

   或者克隆源代码并在编辑模式下安装 DLTK（推荐）：

   cd MY_WORKSPACE_DIRECTORY
   git clone https://github.com/DLTK/DLTK.git 
   cd DLTK
   pip install -e .
   

   这样您可以直接修改 DLTK 的源代码，并通过 import dltk 在需要的地方导入并使用修改后的版本。

开始使用

1. 下载示例数据 您可以在 data 目录中找到公开可用数据集的下载和预处理脚本。要下载 IXI HH 数据集，进入 data/IXI_HH 目录，并运行下载脚本：

   python download_IXI_HH.py
   

2. 教程笔记本 在 examples/tutorials 目录中，您会找到一些教程笔记本，帮助您更好地理解 DLTK 如何与 TensorFlow 集成、如何编写自定义读取函数以及如何实现自己的 model_fn。

   要运行笔记本，请进入 DLTK 源码根目录，并在 MY_PORT 端口（默认 8888）启动 Jupyter Notebook 服务器：

   cd MY_WORKSPACE_DIRECTORY/DLTK
   jupyter notebook --ip=* --port MY_PORT
   

   打开浏览器，输入地址 http://localhost:MY_PORT 或 http://MY_DOMAIN_NAME:MY_PORT，然后导航到 examples/tutorials 中的某个笔记本，打开它（扩展名为 .ipynb），进行修改或运行。

3. 示例应用 在 examples/applications 目录中，有多个使用第 1 步中数据的示例应用。每个文件夹都包含一个实验设置和相应的应用。请注意，这些示例并非针对高性能优化，而是用于展示如何使用 DLTK 模型生成可运行的脚本。 更多说明和预期结果，请参阅各个示例的 README.md 文件。

DLTK 模型库

我们还在一个独立的仓库 DLTK/models 中提供了一个模型库，其中包含了当前研究方法的重新实现。模型库中的每个模型均由其原作者维护，其实现方式通常与 examples/applications 中的实现有所不同。有关模型库中各个应用的具体说明和信息，请参阅相应的 README.md 文件。

如何贡献

我们非常感谢对 DLTK 及其模型库的任何贡献。如果您有改进建议、新功能或补丁，请向我们提交 Pull Request！您可以在 GitHub 上找到关于如何发起 PR 的具体说明 这里。如果您发现了 bug，欢迎随时创建一个 issue，或者直接到我们的 Gitter 频道与我们交流 。

基本贡献指南

• Python 编码风格：与 TensorFlow 类似，我们大致遵循 Google Python 编码规范 和 Google 文档字符串规范。
• 完全新的功能应在合并到核心代码之前先提交到 dltk/contrib 目录下。
• 独立的问题特定应用或已发表方法的（重新）实现应提交到 DLTK 模型库 仓库，并提供包含作者/开发者联系方式的 README.md 文件。

在本地运行测试

要在您的机器上运行测试，您可以在 DLTK 根目录下执行 pip install -e '.[tests]' 来安装 tests 附加组件。这将安装所有必要的测试依赖项。随后您可以运行 pytest --cov dltk --flake8 --cov-append 来检查您的代码是否通过测试。

在本地构建文档

要在您的机器上运行测试，您可以在 DLTK 根目录下执行 pip install -e '.[docs]' 来安装 docs 附加组件。这将安装所有文档所需的依赖项。然后您可以运行 make -C docs html 来构建文档。您可以通过任意浏览器访问该文档，只需指向 docs/build/html/index.html 即可。

团队

目前，DLTK 由 @pawni 和 @mrajchl 维护，同时我们也非常感谢以下按字母顺序排列的各位研究人员和工程师的宝贵贡献： @CarloBiffi @ericspod @ghisvail @mauinz @michaeld123 @sk1712

许可证

请参阅 LICENSE

致谢

我们衷心感谢 NVIDIA GPU Computing (http://www.nvidia.com/) 为我们研究工作提供的硬件支持。

DLTK 快速上手指南

DLTK (Deep Learning Toolkit) 是一个基于 TensorFlow 构建的 Python 神经网络工具包，专为医学影像分析设计。它旨在降低入门门槛，加速原型开发，并确保研究的可复现性。

环境准备

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

• 操作系统: Linux, macOS 或 Windows
• Python 版本: 推荐 Python 3 (虽然旧版本支持 Python 2.7，但未来将不再支持)
• 硬件加速: 推荐使用支持 CUDA 的 NVIDIA GPU 以加速训练
• 前置依赖:
  • virtualenv (用于创建隔离环境)
  • pip (Python 包管理工具)
  • git (用于克隆源码)

提示：国内用户建议在安装 Python 依赖时使用清华或阿里镜像源，以提升下载速度。例如：pip install -i https://pypi.tuna.tsinghua.edu.cn/simple <package_name>。

安装步骤

1. 创建并激活虚拟环境

为了避免依赖冲突，强烈建议使用虚拟环境。

virtualenv -p python3 --always-copy venv_tf
source venv_tf/bin/activate

(Windows 用户使用 venv_tf\Scripts\activate)

2. 安装 TensorFlow

DLTK 依赖 TensorFlow (版本 >= 1.4.0)。推荐使用带 GPU 支持的版本。

pip install "tensorflow-gpu>=1.4.0"

(若无需 GPU 支持，可安装 tensorflow)

3. 安装 DLTK

您可以选择直接从 PyPI 安装，或者克隆源码以“编辑模式”安装（推荐开发者使用，方便修改源码）。

方式 A：直接安装 (稳定版)

pip install dltk

方式 B：源码安装 (推荐，可修改源码)

cd MY_WORKSPACE_DIRECTORY
git clone https://github.com/DLTK/DLTK.git 
cd DLTK
pip install -e .

基本使用

安装完成后，您可以通过以下步骤快速体验 DLTK 的功能。

1. 获取示例数据

DLTK 提供了脚本以下载公开的医学影像数据集（如 IXI HH 数据集）。

cd data/IXI_HH
python download_IXI_HH.py

2. 运行教程 Notebook

DLTK 包含详细的 Jupyter Notebook 教程，展示如何与 TensorFlow 交互、编写自定义读取函数以及构建模型 (model_fn)。

启动 Jupyter 服务：

cd MY_WORKSPACE_DIRECTORY/DLTK
jupyter notebook --ip=* --port 8888

在浏览器中访问 http://localhost:8888，导航至 examples/tutorials 目录，打开任意 .ipynb 文件即可运行和学习。

3. 运行示例应用

在 examples/applications 目录下提供了多个完整的应用示例。这些示例展示了如何使用 DLTK 模型构建可运行的脚本。

• 进入对应的应用文件夹。
• 查看该文件夹下的 README.md 了解具体运行指令和预期结果。
• 运行相应的 Python 脚本进行实验。

注意：示例应用主要用于展示功能流程，并未针对高性能进行极致优化。如需更前沿的研究模型实现，请参考 DLTK Model Zoo。