whisperX-FastAPI 的安装和配置教程

1. 项目的基础介绍和主要的编程语言

whisperX-FastAPI 是一个开源项目，基于 WhisperX 模型构建的 REST API 服务，使用 FastAPI 框架开发。该项目提供了对音频和视频文件进行转录、对齐、语音识别等功能。主要编程语言为 Python。

2. 项目使用的关键技术和框架

• FastAPI：一个用于构建 API 的现代、快速（高性能）的 Web 框架，使用 Python 3.6 及以上版本编写。
• WhisperX：一个基于 PyTorch 的音频处理库，提供转录、对齐、语音识别等功能。
• SQLAlchemy：一个 SQL 工具包和对象关系映射（ORM）系统，用于数据库交互。
• Uvicorn 或 Gunicorn：用于部署 FastAPI 应用的 ASGI 服务器。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

• 确保您的系统中已安装 Python 3.6 或更高版本。
• 安装 pip，Python 的包管理器。
• 准备一个虚拟环境（推荐），以避免污染全局 Python 环境。

安装步骤

1. 创建虚拟环境

   在命令行中执行以下命令来创建一个虚拟环境：

   python -m venv venv
   

2. 激活虚拟环境

   根据您的操作系统激活虚拟环境：

   • 在 Windows 上：

     .\venv\Scripts\activate
     

   • 在 macOS 或 Linux 上：

     source venv/bin/activate
     

3. 安装依赖

   进入虚拟环境后，执行以下命令安装项目所需的依赖：

   pip install -r requirements/dev.txt
   

   如果您打算进行生产部署，可以使用：

   pip install -r requirements/prod.txt
   

4. 配置环境变量

   在项目根目录下创建一个 .env 文件，并设置必要的环境变量，例如：

   HF_TOKEN=your_huggingface_token
   WHISPER_MODEL=your_preferred_model
   LOG_LEVEL=your_log_level
   

   替换 your_huggingface_token、your_preferred_model 和 your_log_level 为实际的值。

5. 运行 FastAPI 应用

   使用以下命令来启动 FastAPI 应用：

   uvicorn app.main:app --reload --log-config uvicorn_log_conf.yaml --log-level $LOG_LEVEL
   

   应用将启动并在 http://127.0.0.1:8000 上监听。

注意事项

• 如果您打算使用 Docker 进行部署，请确保已正确配置 Docker 环境，包括安装了 CUDA 驱动，并且 Docker 可以访问 GPU。
• 在生产环境中，推荐使用 Gunicorn 替代 Uvicorn 作为 ASGI 服务器。
• 对于数据库，确保 DB_URL 环境变量设置正确，并且数据库服务正在运行。

完成以上步骤后，您应该能够成功安装并运行 whisperX-FastAPI 项目。