Skip to main content

安装

SSCMA 运行环境依赖于 PyTorch 和来自 OpenMMLab 的各种第三方库。您可以在 GitHub 上找到 SSCMA 代码。要开始使用，请确保您已按照此处的说明在本地安装了 PyTorch，然后获取必要的 OpenMMLab 库。

  • MMCV: OpenMMLab 计算机视觉基础库。
  • MMClassification: OpenMMLab 图像分类工具包和基准测试。除了分类任务外，它还用于提供各种骨干网络。
  • MMDetection: OpenMMLab 检测工具包和基准测试。
  • MMPose: OpenMMLab 姿态估计工具包和基准测试。
  • MIM: MIM 为启动和安装 OpenMMLab 项目及其扩展提供统一接口，并管理 OpenMMLab 模型库。

前提条件​

SSCMA 可在 Linux、Windows 和 macOS 上运行。我们强烈建议您使用 Miniconda 来管理 python 包。 请按照以下步骤准备环境。

tip

Miniconda 是 conda 的免费最小安装程序，您可以从 Miniconda 官方网站 下载并安装 Miniconda3。

步骤 0 - 克隆 Git 仓库​

首先，您需要在本地克隆 SSCMA 源代码。我们使用 Git 进行管理并托管在 GitHub 上，下面提供两种不同的克隆方式（任选其一）。如果您没有安装 Git，可以参考 Git 文档 在您的计算机上配置 Git。

git clone https://github.com/Seeed-Studio/ModelAssistant.git --depth 1 && \
cd ModelAssistant

步骤 1 - 创建虚拟环境​

假设您已安装 conda，然后创建并激活 conda 虚拟环境。

conda create --name sscma python=3.8 -y && \
conda activate sscma

步骤 2 - 安装 PyTorch​

SSCMA 依赖于 PyTorch。在运行以下代码之前，请再次确认您已激活刚才创建的虚拟环境。

对于具有 GPU (CUDA) 的设备，我们建议安装支持 GPU 加速的依赖项。我们在 2 种不同情况下列出了您可以选择的配置选项，请根据您的硬件环境手动选择。

  • 仅 CPU 平台：
conda install pytorch torchvision torchaudio cpuonly -c pytorch
  • GPU (CUDA) 平台：
conda install pytorch torchvision torchaudio pytorch-cuda=11.7 cudatoolkit=11.7 -c pytorch -c nvidia
tip

如果您的平台尚未为 NVIDIA GPU 安装 CUDA，您可以在 NVIDIA CUDA Toolkit 存档网站 上找到 CUDA 安装程序，我们建议在您的主机环境中使用 CUDA 11.7 或更高版本。有关在其他平台上安装 PyTorch 的信息，请在 PyTorch 官方网站 上阅读更多内容。

步骤 3 - 安装基本依赖项​

请确认您已激活虚拟环境并位于 SSCMA 源代码的主工作目录中，然后运行以下代码完成基本依赖项的配置。

pip3 install -r requirements/base.txt && \
mim install -r requirements/mmlab.txt && \
mim install -e .

步骤 4 - 安装额外依赖项（可选）​

如果您需要执行模型转换或推理测试，还需要安装以下额外依赖项。

pip3 install -r requirements/inference.txt -r requirements/export.txt

如果您希望对 SSCMA 进行更改并提交给我们，我们建议您额外运行以下命令，以便在提交时检查您的代码。

pip3 install -r requirements/tests.txt
pre-commit install

其他方法​

如果您已经设置了 Conda，可以在 Linux 上（在 Ubuntu 20.04~22.10 上测试过）使用 shell 脚本自动完成 SSCMA 环境的配置。

bash scripts/setup_linux.sh

或者您可以使用 Conda 的配置文件手动进行配置。

conda env create -n sscma -f environment.yml && \
conda activate sscma && \
pip3 install -r requirements/inference.txt -r requirements/export.txt -r requirements/tests.txt && \
mim install -r requirements/mmlab.txt && \
mim install -e .

提醒​

完成 Miniconda 的安装并使用 Conda 配置 SSCMA 后，我们创建了一个名为 sscma 的 Conda 虚拟环境，并在虚拟环境中安装了依赖项。对于后续的 SSCMA 相关配置和开发，请确保您在 SSCMA 虚拟环境中，您可以使用以下命令激活它。

conda activate sscma

如果您想重新配置或删除 SSCMA 虚拟环境，可以运行以下命令。

conda env remove -n sscma

常见问题​

  • 从 anaconda 默认频道安装包时连接速度很慢。

    请耐心等待并尝试一些第三方镜像频道，例如 SJTU 镜像、TUNA 镜像 等。

Loading Comments...