Prov-GigaPath 项目使用教程

1. 项目的目录结构及介绍

prov-gigapath/
├── data/
│   └── dataset_csv/
├── demo/
├── finetune/
├── gigapath/
├── images/
├── linear_probe/
├── scripts/
├── .gitignore
├── LICENSE
├── README.md
├── environment.yaml
├── pyproject.toml
└── requirements.txt

目录结构介绍

• data/: 存放数据集的目录，dataset_csv/ 子目录可能包含数据集的 CSV 文件。
• demo/: 存放演示代码和示例的目录。
• finetune/: 存放微调代码和相关资源的目录。
• gigapath/: 核心代码目录，包含模型实现和相关功能。
• images/: 存放示例图像的目录。
• linear_probe/: 存放线性探测代码和相关资源的目录。
• scripts/: 存放脚本文件的目录，可能包含启动脚本和配置脚本。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• environment.yaml: Conda 环境配置文件。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: Python 依赖包列表。

2. 项目的启动文件介绍

启动文件

项目的启动文件通常位于 scripts/ 目录下。例如，scripts/run_pcam.sh 和 scripts/run_panda.sh 是用于启动微调实验的脚本。

启动步骤

1. 配置环境: 使用 environment.yaml 文件创建 Conda 环境。

   conda env create -f environment.yaml
   conda activate gigapath
   

2. 安装依赖: 安装项目所需的 Python 依赖包。

   pip install -r requirements.txt
   

3. 运行脚本: 使用脚本启动项目。

   bash scripts/run_pcam.sh
   

3. 项目的配置文件介绍

配置文件

• environment.yaml: 定义了项目所需的 Conda 环境配置。
• pyproject.toml: 定义了 Python 项目的配置，包括项目元数据和构建系统。
• requirements.txt: 列出了项目所需的 Python 依赖包。

配置步骤

1. 编辑环境配置: 如果需要自定义环境，可以编辑 environment.yaml 文件。

   name: gigapath
   channels:
     - defaults
   dependencies:
     - python=3.8
     - pip
     - pip:
       - -r requirements.txt
   

2. 编辑依赖配置: 如果需要添加或删除依赖包，可以编辑 requirements.txt 文件。

   torch==1.9.0
   timm==0.4.12
   

3. 编辑项目配置: 如果需要修改项目元数据或构建系统配置，可以编辑 pyproject.toml 文件。

   [project]
   name = "prov-gigapath"
   version = "0.1.0"
   description = "A whole-slide foundation model for digital pathology from real-world data"
   authors = [
     { name="Hanwen Xu", email="[e-mail]" },
     { name="Naoto Usuyama", email="[e-mail]" },
   ]
   

通过以上步骤，您可以了解并配置 Prov-GigaPath 项目，以便进行进一步的研究和开发。