Skip to content

Document official SDKs #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imdewan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document official SDKs #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Kitten TTS is an open-source, lightweight text-to-speech library built on ONNX.
- [Available Models](#available-models)
- [Demo](#demo)
- [Quick Start](#quick-start)
- [Official SDKs](#official-sdks)
- [API Reference](#api-reference)
- [System Requirements](#system-requirements)
- [Roadmap](#roadmap)
Expand Down Expand Up @@ -111,6 +112,19 @@ m = KittenTTS("KittenML/kitten-tts-mini-0.8", backend="cuda")

Check out `example_cuda.py`

## Official SDKs

Use the official SDKs when you want to run Kitten TTS inside an app runtime instead of calling the Python package directly.

| SDK | Platforms | Notes |
|---|---|---|
| [KittenTTS Swift](https://github.com/KittenML/KittenTTS-swift) | iOS and macOS | Swift Package Manager SDK for on-device text-to-speech with async generation, playback, WAV export, and model caching. |
| [KittenTTS React Native](https://github.com/KittenML/KittenTTS-react-native) | React Native iOS, Android, and Web | Mobile and web SDK for local speech generation, playback helpers, offline assets, and generated word timings. |
| [KittenTTS Flutter](https://github.com/KittenML/KittenTTS-flutter) | Android, iOS, macOS, Linux, and Windows | Flutter SDK for on-device inference, app-provided playback, model caching, streaming generation, and word timings. |
| [KittenTTS Web](https://github.com/KittenML/KittenTTS-web) | Browser and Node.js | TypeScript SDK for browser and Node.js speech generation with WAV/MP3 output, streaming, and word timings. |

Each SDK is in developer preview. See the linked repositories for current installation instructions, platform requirements, examples, and release status.

## API Reference

### `KittenTTS(model_name, cache_dir=None)`
Expand Down Expand Up @@ -179,7 +193,7 @@ A virtual environment (conda, venv, or similar) is recommended to avoid dependen
## Roadmap

- [ ] Release optimized inference engine
- [ ] Release mobile SDK
- [ ] Expand official SDK coverage and platform examples
- [ ] Release higher quality TTS models
- [ ] Release multilingual TTS
- [ ] Release KittenASR
Expand Down