public-mirrors/Kokoro-FastAPI
1
0
Fork 0
mirror of https://github.com/remsky/Kokoro-FastAPI.git synced 2025-08-05 16:48:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
remsky 2025-01-25 06:00:11 -07:00 • committed by GitHub
parent 96d8e1b4c8
commit 55ce88bfb6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -19,16 +19,27 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor
> [!Tip]
> You can try the new beta version from the `v0.1.2-pre` branch now:
> - integrated web UI (on localhost:8880/web)
> - better concurrency handling, baked in models and voices
> - voice name/model mappings to OAI standard with:
>
> ```bash
> 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
> ```
<table>
<tr>
<td>
<img src="https://github.com/user-attachments/assets/440162eb-1918-4999-ab2b-e2730990efd0" width="100%" alt="Voice Analysis Comparison" style="border: 2px solid #333; padding: 5px;">
</td>
<td>
<ul>
<li>Integrated web UI (on localhost:8880/web)</li>
<li>Better concurrency handling, baked in models and voices</li>
<li>Voice name/model mappings to OAI standard</li>
<pre> # with:
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
</pre>
</ul>
</td>
</tr>
</table>
## Quick Start
<details open>
<summary>Quick Start</summary>
The service can be accessed through either the API endpoints or the Gradio web interface.
@ -82,6 +93,8 @@ The service can be accessed through either the API endpoints or the Gradio web i
<img src="ui\GradioScreenShot.png" width="80%" alt="Voice Analysis Comparison" style="border: 2px solid #333; padding: 10px;">
</p>
</details>
## Features
<details>
<summary>OpenAI-Compatible Speech Endpoint</summary>