InstanSeg 开源项目使用教程

1. 项目介绍

InstanSeg 是一个基于 PyTorch 的细胞和核分割管道，用于荧光和亮场显微镜图像。它具有快速、准确的特点，并且可以完全编译为 TorchScript，便于在 Python 以外的环境中使用，例如直接在 QuPath 中运行。InstanSeg 支持多通道图像处理，无需重新训练或手动干预即可用于新型生物标记物面板。

2. 项目快速启动

首先，确保您的环境中已经安装了 PyTorch。以下命令将安装 InstanSeg 的基础包：

pip install instanseg-torch

如果您需要所有用于训练的依赖项，请使用以下命令：

pip install instanseg-torch[full]

接下来，您可以快速开始使用 InstanSeg：

from instanseg import InstanSeg

# 创建一个针对亮场核分割的 InstanSeg 实例
instanseg_brightfield = InstanSeg(
    "brightfield_nuclei",
    image_reader="tiffslide",
    verbosity=1
)

# 对图像进行分割，并保存结果
labeled_output = instanseg_brightfield.eval(
    image="../instanseg/examples/HE_example.tif",
    save_output=True,
    save_overlay=True
)

如果您想对中间步骤有更多控制，可以按照以下步骤操作：

# 读取图像
image_array, pixel_size = instanseg_brightfield.read_image("../instanseg/examples/HE_example.tif")

# 进行分割
labeled_output, image_tensor = instanseg_brightfield.eval_small_image(
    image_array,
    pixel_size
)

# 显示结果
instanseg_brightfield.display(image_tensor, labeled_output)

# 使用工具函数显示图像
from instanseg.utils.utils import show_images
show_images(
    image_tensor,
    labeled_output,
    colorbar=False,
    titles=["标准化图像", "带分割的图像"]
)

3. 应用案例和最佳实践

下载数据集

要下载公共数据集和示例图像，请按照 instanseg/notebooks/load_datasets.ipynb 中的说明操作。

训练模型

要训练您自己的数据集上的 InstanSeg 模型，请扩展 instanseg/notebooks/load_datasets.ipynb 中的一个模板。

以下是一个训练 InstanSeg 的示例命令：

cd instanseg/scripts
python train.py -data segmentation_dataset.pth -source "TNBC_2018" --num_epochs 250 --experiment_str my_first_instanseg --requested_pixel_size 0.25

测试模型

要测试训练好的模型并获取 F1 指标，请使用以下命令：

python test.py --model_folder my_first_instanseg -test_set Validation --optimize_hyperparameters True
python test.py --model_folder my_first_instanseg -test_set Test --params best_params

模型推理

要使用 InstanSeg 进行模型推理，请运行以下命令：

python inference.py --model_folder my_first_instanseg --image_path ../examples

请将 ../examples 替换为您图像的路径。如果 InstanSeg 无法从图像元数据中读取像素大小，用户需要提供 --pixel_size 参数。

4. 典型生态项目

目前，InstanSeg 已经有自己的 QuPath 扩展，可以在 QuPath 中直接使用。更多关于如何集成和使用 InstanSeg 的生态项目，请参考官方文档和相关社区讨论。