mirror of
https://github.com/remsky/Kokoro-FastAPI.git
synced 2025-04-13 09:39:17 +00:00
Update README.md
This commit is contained in:
parent
ee0644f2ba
commit
3acc654f10
1 changed files with 10 additions and 13 deletions
15
README.md
15
README.md
|
@ -23,27 +23,24 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor
|
||||||
|
|
||||||
The service can be accessed through either the API endpoints or the Gradio web interface.
|
The service can be accessed through either the API endpoints or the Gradio web interface.
|
||||||
|
|
||||||
1. Install prerequisites:
|
1. Install prerequisites, and start the service using Docker Compose (Full setup including UI):
|
||||||
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
|
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
|
||||||
- Clone the repository:
|
- Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/remsky/Kokoro-FastAPI.git
|
git clone https://github.com/remsky/Kokoro-FastAPI.git
|
||||||
cd Kokoro-FastAPI
|
cd Kokoro-FastAPI
|
||||||
# * Switch to stable branch *
|
|
||||||
|
# * Switch to stable branch if any issues *
|
||||||
git checkout v0.0.5post1-stable
|
git checkout v0.0.5post1-stable
|
||||||
```
|
|
||||||
|
|
||||||
2. Start the service:
|
|
||||||
|
|
||||||
- Using Docker Compose (Full setup including UI):
|
|
||||||
```bash
|
|
||||||
cd docker/gpu # OR
|
cd docker/gpu # OR
|
||||||
# cd docker/cpu # Run this or the above
|
# cd docker/cpu # Run this or the above
|
||||||
docker compose up --build
|
docker compose up --build
|
||||||
```
|
```
|
||||||
- OR running the API alone using Docker (model + voice packs baked in):
|
|
||||||
```bash
|
|
||||||
|
|
||||||
|
__Or__ running the API alone using Docker (model + voice packs baked in) (Most Recent):
|
||||||
|
|
||||||
|
```bash
|
||||||
docker run -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-cpu:v0.1.0post1 # CPU
|
docker run -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-cpu:v0.1.0post1 # CPU
|
||||||
docker run --gpus all -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-gpu:v0.1.0post1 # Nvidia GPU
|
docker run --gpus all -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-gpu:v0.1.0post1 # Nvidia GPU
|
||||||
```
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue