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 GitHub Actions workflow and README for Docker publishing and new badge

Browse source
This commit is contained in:
remsky 2025-01-02 20:27:12 -07:00
parent ee5be65596
commit f1131b4836
2 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
.github/workflows/docker-publish.yml vendored
View file

@ -4,8 +4,18 @@ on:
push: push:
branches: [ "master" ] branches: [ "master" ]
tags: [ 'v*.*.*' ] tags: [ 'v*.*.*' ]
paths:
- '**.py'
- '**/Dockerfile*'
- '**/docker-compose*.yml'
- 'requirements*.txt'
pull_request: pull_request:
branches: [ "master" ] branches: [ "master" ]
paths:
- '**.py'
- '**/Dockerfile*'
- '**/docker-compose*.yml'
- 'requirements*.txt'
# Allow manual trigger from GitHub UI # Allow manual trigger from GitHub UI
workflow_dispatch: workflow_dispatch:

7
README.md
View file

@ -5,7 +5,7 @@
# Kokoro TTS API # Kokoro TTS API
[![Tests](https://img.shields.io/badge/tests-89%20passed-darkgreen)]() [![Tests](https://img.shields.io/badge/tests-89%20passed-darkgreen)]()
[![Coverage](https://img.shields.io/badge/coverage-80%25-darkgreen)]() [![Coverage](https://img.shields.io/badge/coverage-80%25-darkgreen)]()
[![Tested at Model Commit](https://img.shields.io/badge/last--tested--model--commit-a67f113-blue)](https://huggingface.co/hexgrad/Kokoro-82M/tree/c3b0d86e2a980e027ef71c28819ea02e351c2667) [![Tested at Model Commit](https://img.shields.io/badge/last--tested--model--commit-a67f113-blue)](https://huggingface.co/hexgrad/Kokoro-82M/tree/c3b0d86e2a980e027ef71c28819ea02e351c2667) [![Try on Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Try%20on-Spaces-blue)](https://huggingface.co/spaces/Remsky/Kokoro-TTS-Zero)
Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) text-to-speech model Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) text-to-speech model
- OpenAI-compatible Speech endpoint, with voice combination functionality - OpenAI-compatible Speech endpoint, with voice combination functionality
@ -14,6 +14,8 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor
- automatic chunking/stitching for long texts - automatic chunking/stitching for long texts
- simple audio generation web ui utility - simple audio generation web ui utility
## Quick Start ## Quick Start
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.
@ -222,6 +224,3 @@ This project is licensed under the Apache License 2.0 - see below for details:
The full Apache 2.0 license text can be found at: https://www.apache.org/licenses/LICENSE-2.0 The full Apache 2.0 license text can be found at: https://www.apache.org/licenses/LICENSE-2.0
</details> </details>