11# Contributing
22
3- ` wfloat ` is now a pure Python package. Native code comes from a separately
4- installed ` sherpa-onnx ` wheel .
3+ ` wfloat ` is a pure Python package. Native code comes from the
4+ ` wfloat- sherpa-onnx` dependency, which provides ` import sherpa_onnx ` .
55
66## Prerequisites
77
88- Python 3.9+
9- - a compatible ` sherpa-onnx ` wheel available from GitHub Releases or another
10- package source
119
1210## Local setup
1311
@@ -18,18 +16,14 @@ python -m pip install --upgrade pip
1816python -m pip install setuptools wheel build twine
1917```
2018
21- Install ` sherpa-onnx ` first if you want to exercise the low-level bindings:
22-
23- ``` bash
24- pip install https://github.com/wfloat/sherpa-onnx/releases/download/< tag> /< wheel> .whl
25- ```
26-
27- Then install ` wfloat ` :
19+ Install ` wfloat ` :
2820
2921``` bash
3022pip install -e .
3123```
3224
25+ That will also install the matching ` wfloat-sherpa-onnx ` dependency.
26+
3327## Build release artifacts
3428
3529``` bash
@@ -44,14 +38,13 @@ That produces:
4438
4539## Tests
4640
47- Unit tests do not require ` sherpa-onnx ` :
41+ Unit tests do not require ` sherpa_onnx ` :
4842
4943``` bash
5044python -m unittest discover -s tests -v
5145```
5246
53- If you have installed a compatible ` sherpa-onnx ` wheel, you can also run a
54- simple smoke check:
47+ You can also run a smoke check:
5548
5649``` bash
5750python -c " import sherpa_onnx, wfloat; print(wfloat.__version__)"
@@ -63,7 +56,5 @@ CI now:
6356
6457- builds pure Python artifacts once
6558- installs those artifacts on each target platform
66- - runs the unit test suite
67-
68- After ` sherpa-onnx ` release assets are published, CI can add a platform-specific
69- install step that pulls those wheel URLs before running integration smoke tests.
59+ - relies on normal dependency resolution for ` wfloat-sherpa-onnx `
60+ - runs the unit test suite and an integration smoke test
0 commit comments