安装指南

安装指南#

本文档提供了在不同操作系统上设置 audio2face 开发环境的分步说明。

目录#

Linux 环境设置#

Linux 前置条件#

在开始之前，请确保您满足以下系统要求：

  • Ubuntu 20.04 或兼容的 Linux 发行版

  • 用于下载软件包的网络连接

Linux 步骤1：安装 Protocol Buffers#

下载并安装用于pb文件编译的 protoc：

# 创建 protoc 目录
mkdir -p protoc
cd protoc

# 下载 protoc
curl -LjO https://github.com/protocolbuffers/protobuf/releases/download/v31.1/protoc-31.1-linux-x86_64.zip

# 解压并设置权限
unzip protoc-31.1-linux-x86_64.zip
rm -f protoc-31.1-linux-x86_64.zip
chmod +x bin/protoc

# 验证安装
bin/protoc --version

# 返回根目录
cd ..

Linux 步骤2：设置 Python#

您需要 Python 3.10 或更高版本来运行此项目。本文档提供了使用 conda 安装 Python 的方法作为参考。

使用 Miniconda 安装 Python：

# 下载 Miniconda 安装程序
wget -q https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh

# 安装 Miniconda
bash Miniconda3-latest-Linux-x86_64.sh

# 清理安装程序
rm -f Miniconda3-latest-Linux-x86_64.sh

# 配置 conda 频道
conda config --add channels conda-forge
conda tos accept

# 使用 Python 3.10 创建 audio2face 环境
conda create -n audio2face python=3.10 -y

# 激活环境
conda activate audio2face

Linux 步骤3：安装 PyTorch 和 ONNX Runtime#

audio2face 服务支持 CPU 和 GPU 推理。根据您的硬件配置选择合适的安装方法。

方案 A：CPU 推理环境（默认）#

对于仅 CPU 推理，安装支持 CPU 的 PyTorch 和 ONNX Runtime：

# 激活环境
conda activate audio2face

# 安装支持 CPU 的 PyTorch
conda install pytorch==2.4.1 torchaudio==2.4.1 cpuonly -c pytorch

# 安装支持 CPU 的 ONNX Runtime
pip install onnxruntime==1.22.0

方案 B：GPU 推理环境（如果存在支持 CUDA 的 GPU，推荐此环境）#

为了 GPU 加速推理以获得更快的处理速度，安装支持 CUDA 的 PyTorch 和 ONNX Runtime：

# 激活环境
conda activate audio2face

# 安装支持 CUDA 12.1 的 PyTorch
conda install pytorch==2.4.1 torchvision==0.19.1 torchaudio==2.4.1 pytorch-cuda=12.1 -c pytorch -c nvidia -y

# 安装支持 GPU 的 ONNX Runtime
pip install onnxruntime-gpu==1.22.0

注意：GPU 推理需要支持 CUDA 12.1 的 NVIDIA GPU。如果您没有兼容的 GPU，请使用方案 A 进行 CPU 推理。

Linux 步骤4：安装项目#

安装 audio2face 包：

# 确保您在项目根目录
cd /path/to/audio2face

# 激活 conda 环境
conda activate audio2face

# 安装包
pip install .

Linux 步骤5：验证安装#

测试一切是否正常工作：

# 激活环境
conda activate audio2face

# 检查是否可以导入 audio2face.apis
python -c "import audio2face.apis; print('audio2face.apis imported successfully')"

# 检查主应用程序是否运行
python main.py --help

Linux 环境激活#

要使用 audio2face 项目，请始终首先激活 conda 环境：

# 激活环境
conda activate audio2face

# 您的终端现在应该显示 (audio2face)
# 您现在可以运行 Python 脚本并使用 audio2face 包

Windows 环境设置#

Windows 前置条件#

在开始之前，请确保您满足以下系统要求：

  • Windows 10/11 或兼容的 Windows 发行版

  • 用于下载软件包的网络连接

Windows 步骤1：安装 Protocol Buffers#

下载并安装用于协议缓冲区编译的 protoc：

  1. 下载 protoc：

  2. 解压文件：

    • 在项目根目录中创建 protoc 文件夹

    • 将下载的 protoc-31.1-win64.zip 文件解压到 protoc 文件夹中

    • 确保可执行文件位于：protoc\bin\protoc.exe

  3. 验证安装：

    # 在项目目录中打开命令提示符
protoc\bin\protoc.exe --version

Windows 步骤2：设置 Python#

您需要 Python 3.10 或更高版本来运行此项目。本文档提供了使用 conda 安装 Python 的方法作为参考。

使用 Miniconda 安装 Python：

  1. 下载并安装 Miniconda：

    • 访问 Miniconda 安装指南

    • 从 Anaconda 网站下载 Windows 安装程序

    • 按照官方安装说明安装 Miniconda

    • 重要：在安装过程中，确保选中”将 Miniconda3 添加到我的 PATH 环境变量”或在 PATH 环境变量中手动添加 Miniconda3/Scripts 目录，以便从任何终端使用 conda 命令

  2. 创建并激活环境：

    # 使用 Python 3.10 创建 audio2face 环境
conda create -n audio2face python=3.10 -y

# 激活环境
conda activate audio2face

Windows 步骤3：安装 PyTorch 和 ONNX Runtime#

为 Windows 安装支持 CPU 的 PyTorch 和 ONNX Runtime：

# 激活环境
conda activate audio2face

# 安装支持 CPU 的 PyTorch
conda install pytorch==2.4.1 torchaudio==2.4.1 cpuonly -c pytorch

# 安装支持 CPU 的 ONNX Runtime
pip install onnxruntime==1.22.0

Windows 步骤4：安装项目#

安装 audio2face 包：

# 确保您在项目根目录
cd /path/to/audio2face

# 激活 conda 环境
conda activate audio2face

# 临时将 protoc 添加到此会话的 PATH
set PATH=%PATH%;%CD%\protoc\bin

# 安装包
pip install .

Windows 步骤5：验证安装#

测试一切是否正常工作：

# 激活环境
conda activate audio2face

# 检查是否可以导入 audio2face.apis
python -c "import audio2face.apis; print('audio2face.apis imported successfully')"

# 检查主应用程序是否运行
python main.py --help

Windows 环境激活#

要使用 audio2face 项目，请始终首先激活 conda 环境：

# 激活环境
conda activate audio2face

# 您的终端现在应该显示 (audio2face)
# 您现在可以运行 Python 脚本并使用 audio2face 包
Contents