Skip to content
This repository was archived by the owner on Oct 6, 2026. It is now read-only.

Latest commit

 

History

History
76 lines (51 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 1.52 KB

Contributing

wfloat is the Python client for wfloat-tts, Wfloat's on-device text-to-speech model.

Product context:

This repo should stay focused on the Python experience.

Prerequisites

  • Python 3.9+

Local setup

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install setuptools wheel build twine

Install wfloat:

python3 -m pip install -e .

That also installs the matching wfloat-sherpa-onnx dependency.

Build release artifacts

rm -rf build dist
python3 -m build

That produces:

  • dist/*.whl
  • dist/*.tar.gz

Tests

Unit tests do not require sherpa_onnx:

PYTHONPATH=python python3 -m unittest discover -s tests -v

You can also run a smoke check:

python3 -c "import sherpa_onnx, wfloat; print(wfloat.__version__)"

CI

CI:

  • builds pure Python artifacts once
  • installs those artifacts on each target platform
  • relies on normal dependency resolution for wfloat-sherpa-onnx
  • runs the unit test suite and an integration smoke test

Notes for changes

  • Keep docs short and user-facing.
  • Describe this package as the Python way to run wfloat-tts locally.
  • If voices, emotions, or examples change, check the model card and docs first.