Nobrainer-zoo

Nobrainer-zoo是一个工具箱，包含一系列深度学习神经影像模型，简化了各种应用中对预训练模型的使用。Nobrainer-zoo提供了训练/推理模型所需的所有依赖环境。您需要 singularity/apptainer (>= 3.7.x/1.0.x) 或 docker 来运行Nobrainer-zoo。

安装

我们强烈建议为nobrainer-zoo创建一个单独的环境。您可以使用conda或python创建环境。

conda create -n nobrainer-zoo python=3
conda activate nobrainer-zoo

或

python3 -m venv /path/to/new/virtual/environment/nobrainer-zoo
source /path/to/new/virtual/environment/nobrainer-zoo/bin/activate

然后安装nobrainer-zoo

[Releases]    pip install nobrainer-zoo
[Dev version] pip install https://github.com/neuronets/nobrainer-zoo/archive/refs/heads/main.zip

安装后，Nobrainer-zoo应该初始化。它还需要一个缓存文件夹来根据您的需求下载一些辅助文件。默认情况下，它在您的家目录（~/.nobrainer）中创建一个缓存文件夹。如果您不想在家目录中创建缓存文件夹，您可以通过设置环境变量 NOBRAINER_CACHE 来设置不同的缓存位置。运行以下命令来设置它。

export NOBRAINER_CACHE=<path_to_your_cache_directory>

由于此环境变量在您关闭终端会话时将丢失，您需要在下一次运行它，或者更好的解决方案是将其添加到您的~/.bashrc文件中。只需用您的文本编辑器打开文件，并在末尾添加上述行。重新启动您的终端或通过.~/bashrc重新运行bashrc文件，以使此更改生效。

要初始化nobrainer-zoo，请运行

nobrainer-zoo init

注意：您只需要初始化一次nobrainer-zoo。

运行帮助以查看函数及其选项。

nobrainer-zoo --help
nobrainer-zoo ls --help
nobrainer-zoo predict --help
nobrainer-zoo fit --help
nobrainer-zoo register --help
nobrainer-zoo generate --help

可用模型

要在nobrainer-zoo中查看可用模型的列表，请运行nobrainer-zoo ls

模型基于它们的组织、模型名称和版本添加。一个模型可能有不同的版本。一些模型（如kwyk或SyntSR）有各种类型，这意味着存在不同的训练方法或数据集导致了不同的训练模型。您可以使用model_type选项为训练和推理选择模型类型。

即将添加的模型列表可以在这里找到。您可以在这里建议一个模型。

注意：模型在其原始许可证下分发。

推理示例

使用默认选项进行推理，

nobrainer-zoo predict -m neuronets/brainy/0.1.0 <path_to_input> <path_to_save_output>

nobrainer-zoo register -m DDIG/SynthMorph/1.0.0 --model_type brains <path_to_moving> <path_to_fixed> <path_to_moved>

使用--options参数将模型特定选项传递给模型。

nobrainer-zoo predict -m neuronets/brainy/0.1.0 <path_to_input> <path_to_save_output> --options verbose block_shape=[128,128,128]

nobrainer-zoo predict -m UCL/SynthSeg/0.1 <path_to_input> <path_to_save_output> --options post=<path_to_posteriors>

注意：Nobrainer-zoo默认使用GPU。因此，如果您想在有GPU可用的情况下强制使用CPU，则需要传递--cpu标志。如果您在没有GPU的docker中运行，则必须传递--cpu标志。否则，您将收到错误。

注意：如果您使用docker，请确保使用绝对路径输入和输出文件。

训练示例

对于使用样本数据集的训练，您不需要传递任何数据集模式。

nobrainer-zoo fit -m neuronets/brainy

要使用您自己的数据训练网络，请以tfrecords的形式传递数据集模式。

nobrainer-zoo fit -m neuronets/brainy "<data_train_pattern>" "<data_evaluate_pattern>"

可以通过提供规范文件或使用cli命令更改其他参数。

nobrainer-zoo fit -m neuronets/brainy --spec_file <path_to_spec_file>

nobrainer-zoo fit -m neuronets/brainy --train epoch=2