EdgeSAM 项目教程

1. 项目目录结构及介绍

EdgeSAM 项目的目录结构如下：

EdgeSAM/
├── edge_sam/
│   ├── __init__.py
│   ├── model.py
│   └── ...
├── evaluation/
│   ├── eval_script.py
│   └── ...
├── notebooks/
│   ├── example.ipynb
│   └── ...
├── scripts/
│   ├── export_coreml_model.py
│   └── ...
├── training/
│   ├── train_script.py
│   └── ...
├── web_demo/
│   ├── gradio_app.py
│   └── ...
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── README_TRAIN.md
├── requirements.txt
├── setup.cfg
└── setup.py

目录结构介绍

• edge_sam/: 包含 EdgeSAM 模型的核心代码，如模型定义、预测器等。
• evaluation/: 包含评估脚本和相关文件，用于评估模型的性能。
• notebooks/: 包含 Jupyter Notebook 示例，展示如何使用 EdgeSAM 进行预测。
• scripts/: 包含一些实用脚本，如模型导出脚本。
• training/: 包含训练脚本和相关文件，用于训练 EdgeSAM 模型。
• web_demo/: 包含 Web 演示的代码，使用 Gradio 构建交互式演示。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目许可证文件。
• README.md: 项目主 README 文件，包含项目概述和使用说明。
• README_TRAIN.md: 训练相关说明文件。
• requirements.txt: 项目依赖包列表。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。

2. 项目启动文件介绍

启动文件

• web_demo/gradio_app.py: 这是 EdgeSAM 项目的启动文件，用于启动 Web 演示。通过运行此文件，可以在本地启动一个交互式的 Web 演示，展示 EdgeSAM 模型的功能。

启动命令

python web_demo/gradio_app.py

默认情况下，Web 演示将托管在 http://0.0.0.0:8080/。可以通过以下命令自定义服务器名称和端口：

python web_demo/gradio_app.py --checkpoint [CHECKPOINT] --server-name [SERVER_NAME] --port [PORT]

3. 项目配置文件介绍

配置文件

• setup.cfg: 这是 EdgeSAM 项目的主要配置文件，包含了项目的各种配置选项，如安装路径、依赖包等。

配置文件内容示例

[metadata]
name = EdgeSAM
version = 0.1.0
description = Official PyTorch implementation of "EdgeSAM: Prompt-In-the-Loop Distillation for On-Device Deployment of SAM"
author = Chong Zhou, Xiangtai Li, Chen Change Loy, Bo Dai
license = MIT

[options]
packages = find:
install_requires =
    torch==2.0.0
    torchvision==0.15.1
    ...

配置文件说明

• [metadata]: 包含项目的元数据，如项目名称、版本、描述、作者和许可证。
• [options]: 包含项目的安装选项，如需要安装的包和依赖项。

通过这些配置文件，可以方便地管理和配置 EdgeSAM 项目。