Whisper ASR Webservice 使用教程

目录结构及介绍

Whisper ASR Webservice 项目的目录结构如下：

whisper-asr-webservice/
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── docs/
│   └── assets/
│       └── img/
│           └── ...
├── github/
│   └── workflows/
│       └── ...
├── .dockerignore
├── .gitignore
├── Dockerfile
├── Dockerfile.gpu
├── LICENCE
├── README.md
├── docker-compose.gpu.yml
├── docker-compose.yml
├── poetry.lock
└── pyproject.toml

主要目录和文件介绍：

• app/: 包含应用程序的主要代码。
  • main.py: 项目的启动文件。
• docs/: 包含项目文档的资源文件。
• github/: 包含 GitHub 工作流配置文件。
• .dockerignore: Docker 构建时忽略的文件和目录。
• .gitignore: Git 版本控制时忽略的文件和目录。
• Dockerfile: 用于构建 Docker 镜像的文件。
• Dockerfile.gpu: 用于构建支持 GPU 的 Docker 镜像的文件。
• LICENCE: 项目的许可证文件。
• README.md: 项目的主文档文件。
• docker-compose.gpu.yml: 用于启动支持 GPU 的 Docker 服务的配置文件。
• docker-compose.yml: 用于启动 Docker 服务的配置文件。
• poetry.lock: Poetry 依赖管理工具的锁定文件。
• pyproject.toml: Poetry 依赖管理工具的配置文件。

项目的启动文件介绍

项目的启动文件位于 app/main.py。该文件包含了应用程序的主要逻辑和启动代码。以下是 main.py 的简要介绍：

# app/main.py

from fastapi import FastAPI
from whisper_asr_webservice import WhisperASRWebService

app = FastAPI()

@app.on_event("startup")
async def startup_event():
    # 初始化 Whisper ASR Web 服务
    WhisperASRWebService.initialize()

@app.get("/")
async def root():
    return {"message": "Welcome to Whisper ASR Webservice!"}

# 其他路由和逻辑...

主要功能：

• FastAPI 实例化：使用 FastAPI 框架创建一个 Web 应用程序。
• startup_event：在应用程序启动时初始化 Whisper ASR Web 服务。
• 路由定义：定义了应用程序的根路由和其他路由。

项目的配置文件介绍

项目的配置文件主要包括 docker-compose.yml 和 docker-compose.gpu.yml。以下是这两个文件的简要介绍：

docker-compose.yml

version: '3.8'
services:
  whisper-asr:
    image: onerahmet/openai-whisper-asr-webservice:latest
    ports:
      - "9000:9000"
    environment:
      - ASR_MODEL=base
      - ASR_ENGINE=openai_whisper

docker-compose.gpu.yml

version: '3.8'
services:
  whisper-asr-gpu:
    image: onerahmet/openai-whisper-asr-webservice:latest-gpu
    ports:
      - "9000:9000"
    environment:
      - ASR_MODEL=base
      - ASR_ENGINE=openai_whisper
    deploy:
      resources:
        reservations:
          devices:
            - capabilities: [gpu]

主要配置项：

• image: 指定使用的 Docker 镜像。
• ports: 映射容器端口到主机端口。
• environment: 设置环境变量，如 ASR_MODEL 和 ASR_ENGINE。
• deploy: 对于 GPU 版本，指定 GPU 资源。

通过这些配置文件，可以方便地启动和管理 Whisper ASR Webservice 的 Docker 容器。