napari-bioimageio

napari插件，用于管理BioImage Model Zoo中的AI模型。

警告：这是一个alpha版本。API可能在未来的版本中更改，请随时创建问题以报告错误或提供反馈。

安装

pip install napari-bioimageio

(如果您还没有安装napari，请运行pip install napari[pyqt5])

用法

这个库旨在帮助开发者在napari中轻松处理模型。

我们提供一组API函数用于管理和选择模型。

show_model_manager()

显示模型管理器，从BioImage Model Zoo拉取模型列表，用户可以探索所有可用的模型，下载或删除模型。

show_model_selector(filter=None)

显示一个对话框，用于从BioImage Model Zoo中选择模型，用户可以选择现有模型或从BioImage Model Zoo下载。

如果用户选择了一个模型，将返回选择模型的详细信息（一个字典），否则返回None。

一旦用户选择了模型，您可以访问名称以及模型资源描述文件的文件路径（通过rdf_source键）。使用bioimageio.core库（通过pip install bioimageio.core或conda install -c conda-forge bioimageio.core安装），可以直接运行推理。以下示例展示了如何实现它

# Popup a model selection dialog for choosing the model
model_info = show_model_selector(filter=nuclear_segmentation_model_filter)

if model_info:
  self.nucseg_model_source = model_info["rdf_source"]
  # Load model 
  model_description = bioimageio.core.load_resource_description(model_info["rdf_source"])
  input_image = imageio.imread("./my-image.tif")

  with bioimageio.core.create_prediction_pipeline(
      bioimageio_model=model_description
  ) as pipeline:
    output_image = bioimageio.core.prediction.predict_with_padding(
        pipeline, input_image, padding=padding
    )

注意：要运行模型，您需要根据bioimageio.core的安装指南正确设置conda环境。

更多示例，请参阅此示例笔记本以了解bioimageio.core的使用。

您还可以通过搜索模型文件夹直接访问权重文件（例如，通过os.path.dirname(model_description["rdf_source"])提取模型文件夹路径），如果您更愿意使用自己的模型推理逻辑，这将很有用。

show_model_uploader()

显示一个对话框，指导用户将模型包上传到BioImage模型库。目前，它只显示一条消息，将来，我们将尝试支持使用从Zenodo（BioImage模型库用于存储模型的公共数据存储库）获取的凭据直接上传。

要创建与BioImageIO兼容的模型包，您可以使用此笔记本中展示的build_model函数。

开发

• 安装和设置开发环境。

  pip install -r requirements_dev.txt
  

  这将安装所有需求。它还将以开发模式安装此包，这样代码更改将立即应用，无需重新安装。

• 以下是我们在开发中使用的工具列表。

  • black
  • flake8
  • mypy
  • pydocstyle
  • pylint
  • pytest
  • tox

• 建议在代码编辑器中也使用相应的代码格式化器和代码检查工具以获得即时反馈。一个可以做到这一点的流行编辑器是vscode。

• 运行所有测试，检查格式和代码检查。

  tox
  

• 运行单个tox环境。

  tox -e lint
  

• 重新安装所有tox环境。

  tox -r
  

• 运行pytest和所有测试。

  pytest
  

• 运行pytest并为包计算覆盖率。

  pytest --cov-report term-missing --cov=napari-bioimageio
  

• 默认情况下，通过GitHub actions支持持续集成。GitHub actions对公共存储库是免费的，并且每个私有存储库每月提供2000分钟的免费Ubuntu构建时间。