FastKoko

Kokoro-82M文本转语音模型的Docker化FastAPI封装

• OpenAI兼容的语音端点，支持多语言
• 英语（美国/英国）、西班牙语、法语、印地语、意大利语、日语、巴西葡萄牙语、普通话
• 逐词带时间戳的字幕生成，支持加权组合的语音混合
• 音素端点：从文本生成音素，或从音素生成音频
• 预构建的多平台镜像
• CPU和NVIDIA GPU（CUDA）：linux/amd64 + linux/arm64
• AMD GPU（ROCm，实验性）：仅linux/amd64
• 通过UV直接运行时支持Apple Silicon（MPS）（无镜像）

集成指南

快速开始

最快开始（docker run）

提供可运行的预构建镜像，支持arm/多架构，且内置模型。有关可通过环境管理的变量完整列表，请参考core/config.py文件。

# 可以使用`latest`标签，但它可能包含一些影响稳定性的意外附加功能。
### 常规使用时应固定命名版本。
### 始终欢迎反馈/测试

docker run -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-cpu:latest # CPU，或：
docker run --gpus all -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-gpu:latest # NVIDIA GPU，或：
docker run --device=/dev/kfd --device=/dev/dri -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-rocm:latest # AMD GPU（ROCm，实验性，仅amd64）

快速开始（docker compose）

1. 安装先决条件，并使用Docker Compose启动服务（完整设置，包括UI）：

• 安装Docker
• 克隆仓库：

git clone https://github.com/remsky/Kokoro-FastAPI.git
cd Kokoro-FastAPI

cd docker/gpu # 用于NVIDIA GPU支持
# 或 cd docker/cpu # 用于CPU支持
# 或 cd docker/rocm # 用于AMD GPU（ROCm，实验性，仅amd64）
docker compose up --build

# *Apple Silicon（M1/M2/M3）用户注意：
# Docker GPU镜像是仅CUDA的，无法在Apple Silicon上运行。使用Docker时，请使用`docker/cpu`。
# 如需原生MPS（Apple GPU）加速，请通过UV直接运行`./start-gpu_mac.sh`。

# 模型将自动下载，如有需要也可手动下载：
python docker/scripts/download_model.py --output api/src/models/v1_0

# 或通过UV直接运行：
./start-gpu.sh # 用于GPU支持
./start-cpu.sh # 用于CPU支持

直接运行（通过uv）

1. 安装先决条件（）：

• 安装astral-uv
• 如需将其作为未知单词/声音的后备方案，请在系统中安装https://github.com/espeak-ng/espeak-ng%E3%80%82%E4%B8%8A%E6%B8%B8%E5%BA%93%E5%8F%AF%E8%83%BD%E4%BC%9A%E5%B0%9D%E8%AF%95%E5%A4%84%E7%90%86%E6%AD%A4%E9%97%AE%E9%A2%98%EF%BC%8C%E4%BD%86%E7%BB%93%E6%9E%9C%E5%90%84%E4%B8%8D%E7%9B%B8%E5%90%8C%E3%80%82
• 克隆仓库：

git clone https://github.com/remsky/Kokoro-FastAPI.git
cd Kokoro-FastAPI

如果尚未运行https://github.com/remsky/Kokoro-FastAPI/blob/master/docker/scripts/download_model.py%EF%BC%8C%E8%AF%B7%E8%BF%90%E8%A1%8C%E5%AE%83

通过UV直接启动（带热重载）

Linux和macOS

./start-cpu.sh 或
./start-gpu.sh

Windows

.\start-cpu.ps1 或
.\start-gpu.ps1

启动并运行？

作为OpenAI兼容的语音端点在本地运行

from openai import OpenAI

client = OpenAI(
base_url="http://localhost:8880/v1", api_key="not-needed"
)

with client.audio.speech.with_streaming_response.create(
model="kokoro",
voice="af_sky+af_bella", #单个或多个语音包组合
input="Hello world!"
) as response:
response.stream_to_file("output.mp3")

• API将在http://localhost:8880可用
• API文档：http://localhost:8880/docs
• Web界面：http://localhost:8880/web

功能

OpenAI兼容的语音端点

# 使用OpenAI的Python库
from openai import OpenAI
client = OpenAI(base_url="http://localhost:8880/v1", api_key="not-needed")
response = client.audio.speech.create(
model="kokoro",
voice="af_bella+af_sky", # 参见/api/src/core/openai_mappings.json进行自定义
input="Hello world!",
response_format="mp3"
)

response.stream_to_file("output.mp3")

或通过Requests：

import requests

response = requests.get("http://localhost:8880/v1/audio/voices")
voices = [v["id"] for v in response.json()["voices"]]

# 生成音频
response = requests.post(
"http://localhost:8880/v1/audio/speech",
json={
"model": "kokoro",
"input": "Hello world!",
"voice": "af_bella",
"response_format": "mp3", # 支持：mp3、wav、opus、flac
"speed": 1.0
}
)

# 保存音频
with open("output.mp3", "wb") as f:
f.write(response.content)

快速测试（从另一个终端运行）：

python examples/assorted_checks/test_openai/test_openai_tts.py # 测试OpenAI兼容性
python examples/assorted_checks/test_voices/test_all_voices.py # 测试所有可用语音

语音组合

• 使用比例进行加权语音组合（例如，"af_bella(2)+af_heart(1)"表示67%/33%的混合）
• 比例会自动归一化至总和100%
• 通过在任何端点的语音名称中添加括号内的权重即可使用
• 保存生成的语音包以供将来使用

组合语音并生成音频：

import requests
response = requests.get("http://localhost:8880/v1/audio/voices")
voices = [v["id"] for v in response.json()["voices"]]

# 示例1：简单语音组合（50%/50%混合）
response = requests.post(
"http://localhost:8880/v1/audio/speech",
json={
"input": "Hello world!",
"voice": "af_bella+af_sky", # 等权重
"response_format": "mp3"
}
)

# 示例2：加权语音组合（67%/33%混合）
response = requests.post(
"http://localhost:8880/v1/audio/speech",
json={
"input": "Hello world!",
"voice": "af_bella(2)+af_sky(1)", # 2:1比例 = 67%/33%
"response_format": "mp3"
}
)

# 示例3：将组合语音下载为.pt文件
response = requests.post(
"http://localhost:8880/v1/audio/voices/combine",
json="af_bella(2)+af_sky(1)" # 2:1比例 = 67%/33%
)

# 保存.pt文件
with open("combined_voice.pt", "wb") as f:
f.write(response.content)

# 使用下载的语音文件
response = requests.post(
"http://localhost:8880/v1/audio/speech",
json={
"input": "Hello world!",
"voice": "combined_voice", # 使用保存的语音文件
"response_format": "mp3"
}
)

多种输出音频格式

• mp3
• wav
• opus
• flac
• m4a
• pcm

流式支持

# OpenAI兼容流式
from openai import OpenAI
client = OpenAI(
base_url="http://localhost:8880/v1", api_key="not-needed")

# 流式保存到文件
with client.audio.speech.with_streaming_response.create(
model="kokoro",
voice="af_bella",
input="Hello world!"
) as response:
response.stream_to_file("output.mp3")

# 流式播放（需要PyAudio）
import pyaudio
player = pyaudio.PyAudio().open(
format=pyaudio.paInt16,
channels=1,
rate=24000,
output=True
)

关键流式指标：

• 首令牌延迟 @ 块大小
• ~300ms（GPU）@ 400
• ~3500ms（CPU）@ 200（旧款 i7）
• ~

处理详情

性能基准测试

基准测试通过本地 API 进行生成，文本长度最长达长篇书籍（约 1.5 小时输出），测量处理时间和实时因子。测试环境如下：

• Windows 11 Home 搭配 WSL2
• NVIDIA 4060Ti 16GB GPU（CUDA 12.1）
• 第 11 代 i7-***（2.5GHz）
• 64GB 内存
• WAV 原生输出
• 测试文本：H.G. Wells -《时间机器》（全文）

关键性能指标：

• 实时速度：35 倍-100 倍（生成时间与输出音频长度比）
• 平均处理速率：137.67 令牌/秒（cl100k_base 编码）

转录往返测试（WER/CER）

端到端往返测试流程：使用 Kokoro 合成音频，通过 https://github.com/SYSTRAN/faster-whisper 将结果转录回文本，与源文本对比。测试脚本和数据位于 examples/assorted_checks/test_transcription/。

长篇英文（整本书《地心游记》，古腾堡计划，语音 af_heart，CUDA float16 上的 base.en Whisper 模型，基准数据基于 cu126 GPU 构建捕获）：

完整回归区间详见 examples/assorted_checks/test_transcription/BASELINE.md。

多语言检查（每种语音一句，多语言 Whisper small 模型。拉丁语系使用 WER，日语/中文/印地语使用 CER）：

注意：这些测试仅基于单句短句，非全面的语言质量基准。它们仅验证每种语音能生成目标语言的可转录音频；更深入的语言质量评估仍在进行中。

复现方法参见 examples/assorted_checks/test_transcription/README.md。

GPU 与 CPU 对比

# GPU：需支持 CUDA 12.6+ 的 NVIDIA 驱动（约 35x-100x 实时速度）
cd docker/gpu
docker compose up --build

# CPU：PyTorch CPU 推理
cd docker/cpu
docker compose up --build

# AMD GPU：ROCm 6.4（实验性，仅支持 amd64）
cd docker/rocm
docker compose up --build

自然边界检测

• 自动在句子边界拆分并拼接
• 有助于减少 artifacts，支持长文本处理（基础模型当前配置仅支持约 30 秒输出）

模型单次可处理最多 510 个音素化令牌块，但这通常会导致“语速过快”或其他 artifacts。服务器中额外增加了一层分块逻辑，可通过环境变量配置 TARGET_MIN_TOKENS、TARGET_MAX_TOKENS 和 ABSOLUTE_MAX_TOKENS 实现灵活分块，默认值分别为：175、250、450。

带时间戳的字幕与音素

生成带词级时间戳的音频（非流式）：

import requests
import base64
import json

response = requests.post(
"http://localhost:8880/dev/captioned_speech",
json={
"model": "kokoro",
"input": "Hello world!",
"voice": "af_bella",
"speed": 1.0,
"response_format": "mp3",
"stream": False,
},
stream=False
)

with open("output.mp3","wb") as f:

audio_json=json.loads(response.content)

# 解码 base64 流为字节
chunk_audio=base64.b64decode(audio_json["audio"].encode("utf-8"))

# 处理流式块
f.write(chunk_audio)

# 打印词级时间戳
print(audio_json["timestamps"])

生成带词级时间戳的音频（流式）：

import requests
import base64
import json

response = requests.post(
"http://localhost:8880/dev/captioned_speech",
json={
"model": "kokoro",
"input": "Hello world!",
"voice": "af_bella",
"speed": 1.0,
"response_format": "mp3",
"stream": True,
},
stream=True
)

f=open("output.mp3","wb")
for chunk in response.iter_lines(decode_unicode=True):
if chunk:
chunk_json=json.loads(chunk)

# 解码 base64 流为字节
chunk_audio=base64.b64decode(chunk_json["audio"].encode("utf-8"))

# 处理流式块
f.write(chunk_audio)

# 打印词级时间戳
print(chunk_json["timestamps"])

音素与令牌接口

将文本转换为音素和/或直接从音素生成音频：

import requests

def get_phonemes(text: str, language: str = "a"):
"""获取输入文本的音素和令牌"""
response = requests.post(
"http://localhost:8880/dev/phonemize",
json={"text": text, "language": language} # "a" 表示美式英语
)
response.raise_for_status()
result = response.json()
return result["phonemes"], result["tokens"]

def generate_audio_from_phonemes(phonemes: str, voice: str = "af_bella"):
"""从音素生成音频"""
response = requests.post(
"http://localhost:8880/dev/generate_from_phonemes",
json={"phonemes": phonemes, "voice": voice},
headers={"Accept": "audio/wav"}
)
if response.status_code != 200:
print(f"错误: {response.text}")
return None
return response.content

# 使用示例
text = "Hello world!"
try:
# 将文本转换为音素
phonemes, tokens = get_phonemes(text)
print(f"音素: {phonemes}") # 例如 ðɪs ɪz ˈoʊnli ɐ tˈɛst
print(f"令牌: {tokens}") # 包含起始/结束令牌的令牌 ID

# 生成并保存音频
if audio_bytes := generate_audio_from_phonemes(phonemes):
with open("speech.wav", "wb") as f:
f.write(audio_bytes)
print(f"生成 {len(audio_bytes)} 字节音频")
except Exception as e:
print(f"错误: {e}")

示例脚本参见 examples/phoneme_examples/generate_phonemes.py。

调试接口

通过以下接口监控系统状态和资源使用：

• /debug/threads - 获取线程信息和堆栈跟踪
• /debug/storage - 监控临时文件和输出目录使用情况
• /debug/system - 获取系统信息（CPU、内存、GPU）

适用于调试资源耗尽或性能问题。

全局 API 的 loguru 日志级别 可通过 API_LOG_LEVEL 环境变量设置。默认值为 DEBUG。

Docker

修改相应的 compose yml 文件或附加到命令行。

docker run --env 'API_LOG_LEVEL=WARNING' ...

通过 UV 直接运行

Linux 和 macOS

export API_LOG_LEVEL=WARNING
./start-cpu.sh OR
./start-gpu.sh

Windows

$env:API_LOG_LEVEL = 'WARNING'
.\start-cpu.ps1 OR
.\start-gpu.ps1

已知问题与故障排除

词语缺失和时间戳丢失

API 会自动对输入文本进行规范化处理，这可能会错误地删除或更改某些短语。可通过在请求 JSON 中添加 "normalization_options":{"normalize": false} 来禁用此功能：

import requests

response = requests.post(
"http://localhost:8880/v1/audio/speech",
json={
"input": "Hello world!",
"voice": "af_heart",
"response_format": "pcm",
"normalization_options":
{
"normalize": False
}
},
stream=True
)

for chunk in response.iter_content(chunk_size=1024):
if chunk:
# 处理流式数据块
pass

版本控制与开发

分支策略：

• release 分支： 包含最新稳定版本，推荐用于生产环境。带有特定版本标签（如 v0.3.0）的 Docker 镜像从此分支构建。
• master 分支： 用于活跃开发。可能包含实验性功能、进行中的更改或尚未纳入稳定版本的修复。如果你需要最新代码，可使用此分支，但请注意其稳定性可能较低。latest Docker 标签通常指向从此分支构建的镜像。

[!NOTE] 本项目本质上是一个以开发为中心的项目。

如果遇到问题，若出现异常情况，你可能需要回退到发布标签中的某个版本，或从源代码构建和/或进行故障排除并提交 PR。

自由开源是社区共同的努力，而一天的时间毕竟有限。如果你想支持这项工作，欢迎提交 PR、请我喝杯咖啡，或报告使用过程中发现的任何错误/功能需求等。

Linux GPU 权限

部分 Linux 用户以非 root 用户运行时可能会遇到 GPU 权限问题。

无法保证所有方法都有效，但以下是一些常见解决方案，请仔细考虑你的安全需求。

选项 1：容器组（可能是最佳选项）

services:
kokoro-tts:
# ... 现有配置 ...
group_add:
- "video"
- "render"

选项 2：主机系统组

services:
kokoro-tts:
# ... 现有配置 ...
user: "${UID}:${GID}"
group_add:
- "video"

[!NOTE] 可能需要将主机用户添加到组中：sudo usermod -aG docker,video $USER 并重启系统。

选项 3：设备权限（谨慎使用）

services:
kokoro-tts:
# ... 现有配置 ...
devices:
- /dev/nvidia0:/dev/nvidia0
- /dev/nvidiactl:/dev/nvidiactl
- /dev/nvidia-uvm:/dev/nvidia-uvm

[!WARNING] 降低系统安全性。仅在开发环境中使用。

[!IMPORTANT] 前提条件：必须正确配置 NVIDIA GPU、驱动程序和容器工具包。

有关更多详细信息，请访问 NVIDIA Container Toolkit 安装指南

模型和许可

模型

本 API 使用 HuggingFace 上的 Kokoro-82M 模型。

访问模型页面了解有关训练、架构和功能的更多详细信息。我与他们的工作没有任何关联，开发此包装器是为了方便使用和个人项目。

许可

本项目采用 Apache License 2.0 许可 - 详情如下：

• Kokoro 模型权重采用 Apache 2.0 许可（参见 模型页面）
• 本仓库中的 FastAPI 包装器代码为匹配许可也采用 Apache 2.0 许可
• 改编自 StyleTTS2 的推理代码采用 MIT 许可

完整的 Apache 2.0 许可文本可在以下地址查看：[***]

贡献者统计

使用 contrib.rocks 生成。