Refresh model card: state the bit-exact result directly
Browse files
README.md
CHANGED
|
@@ -44,8 +44,8 @@ Fine-tuned from the StyleTTS2 LibriTTS second-stage checkpoint by
|
|
| 44 |
here** — obtain it from the upstream release. The frozen helper models (ASR text aligner, JDCNet
|
| 45 |
pitch extractor, PL-BERT) likewise ship inside the upstream repository and are not redistributed.
|
| 46 |
|
| 47 |
-
ChiReSSD's
|
| 48 |
-
repository.
|
| 49 |
|
| 50 |
## Intended use
|
| 51 |
|
|
@@ -54,13 +54,16 @@ disorders.
|
|
| 54 |
|
| 55 |
## Out of scope
|
| 56 |
|
| 57 |
-
- Not a medical device. No diagnostic or treatment decision should rest on its output.
|
| 58 |
- Not a replacement for assessment by a licensed speech-language pathologist.
|
|
|
|
|
|
|
|
|
|
| 59 |
|
| 60 |
## Training data
|
| 61 |
|
| 62 |
Child speech from UltraSuite/CLP-derived recordings, obtained under their own data use
|
| 63 |
-
agreements. The corpus is not released here and is not redistributable: it is identifiable
|
| 64 |
child clinical speech. See `DATA.md` in the code repository for how to obtain comparable data;
|
| 65 |
<https://huggingface.co/datasets/changelinglab/ultrasuite-benchmark> is a suitable starting point
|
| 66 |
for fine-tuning your own model.
|
|
@@ -99,10 +102,24 @@ articulation itself.
|
|
| 99 |
`alpha` is high on purpose. A low `alpha` leans on the reference acoustics, which is exactly
|
| 100 |
where the disordered articulation lives.
|
| 101 |
|
| 102 |
-
Synthesis is stochastic. The initial style latent is zeros rather than a Gaussian draw, but
|
| 103 |
the ADPM2 sampler is ancestral and adds fresh noise at every step, so repeated calls differ in
|
| 104 |
waveform and in duration. Pass a `seed` for reproducible output.
|
| 105 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 106 |
## Usage
|
| 107 |
|
| 108 |
```python
|
|
@@ -119,7 +136,22 @@ wav = model.synthesize(
|
|
| 119 |
Run `chiressd-setup` first: it clones and patches the upstream StyleTTS2 checkout that supplies
|
| 120 |
the architecture and frozen helper models.
|
| 121 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 122 |
## Citation
|
| 123 |
|
| 124 |
-
|
| 125 |
-
Disordered Speech for Automated Clinical Evaluation
|
|
|
|
| 44 |
here** — obtain it from the upstream release. The frozen helper models (ASR text aligner, JDCNet
|
| 45 |
pitch extractor, PL-BERT) likewise ship inside the upstream repository and are not redistributed.
|
| 46 |
|
| 47 |
+
ChiReSSD's own modification to StyleTTS2 is two lines, published as patch files in the code
|
| 48 |
+
repository rather than as a fork.
|
| 49 |
|
| 50 |
## Intended use
|
| 51 |
|
|
|
|
| 54 |
|
| 55 |
## Out of scope
|
| 56 |
|
| 57 |
+
- **Not a medical device.** No diagnostic or treatment decision should rest on its output.
|
| 58 |
- Not a replacement for assessment by a licensed speech-language pathologist.
|
| 59 |
+
- Not validated for populations outside the training corpus — it was adapted to children aged
|
| 60 |
+
5–12 with a Central Scottish accent, and the phonemizer default (`en-gb`) reflects that.
|
| 61 |
+
- Not a general-purpose voice cloning system.
|
| 62 |
|
| 63 |
## Training data
|
| 64 |
|
| 65 |
Child speech from UltraSuite/CLP-derived recordings, obtained under their own data use
|
| 66 |
+
agreements. **The corpus is not released here and is not redistributable**: it is identifiable
|
| 67 |
child clinical speech. See `DATA.md` in the code repository for how to obtain comparable data;
|
| 68 |
<https://huggingface.co/datasets/changelinglab/ultrasuite-benchmark> is a suitable starting point
|
| 69 |
for fine-tuning your own model.
|
|
|
|
| 102 |
`alpha` is high on purpose. A low `alpha` leans on the reference acoustics, which is exactly
|
| 103 |
where the disordered articulation lives.
|
| 104 |
|
| 105 |
+
**Synthesis is stochastic.** The initial style latent is zeros rather than a Gaussian draw, but
|
| 106 |
the ADPM2 sampler is ancestral and adds fresh noise at every step, so repeated calls differ in
|
| 107 |
waveform and in duration. Pass a `seed` for reproducible output.
|
| 108 |
|
| 109 |
+
## Evaluation
|
| 110 |
+
|
| 111 |
+
See the paper. **This model repository does not reproduce the paper's reported numbers**, and the
|
| 112 |
+
code repository does not either: the evaluation corpora are not redistributable, so the numbers
|
| 113 |
+
cannot be independently recomputed from what is published here.
|
| 114 |
+
|
| 115 |
+
## Ethical considerations
|
| 116 |
+
|
| 117 |
+
This model is trained on identifiable clinical recordings of children and is designed to
|
| 118 |
+
reproduce a child's vocal identity accurately. High speaker similarity is the method's goal and
|
| 119 |
+
therefore also its misuse vector: the same property that makes feedback usable in a child's own
|
| 120 |
+
voice makes the model a voice-cloning tool for a minor. Use it only with appropriate consent and
|
| 121 |
+
ethical oversight.
|
| 122 |
+
|
| 123 |
## Usage
|
| 124 |
|
| 125 |
```python
|
|
|
|
| 136 |
Run `chiressd-setup` first: it clones and patches the upstream StyleTTS2 checkout that supplies
|
| 137 |
the architecture and frozen helper models.
|
| 138 |
|
| 139 |
+
## Checkpoint provenance
|
| 140 |
+
|
| 141 |
+
Derived from training checkpoint `epoch_2nd_00003.pth` of the v5 run by keeping `state['net']`
|
| 142 |
+
only, removing the `module.` prefix that DataParallel added to ten of the thirteen submodules,
|
| 143 |
+
and making every tensor detached, CPU-resident and contiguous. Precision is unchanged (float32;
|
| 144 |
+
no fp16 cast, which would alter outputs).
|
| 145 |
+
|
| 146 |
+
- 2258 MB → 767 MB; the 1491 MB removed is optimizer state, which inference never reads
|
| 147 |
+
- `sha256` of `model.pth`: `6c5faf5b4967b4d26cb4c58d4517dcc477729a579039316741bd88b9bd0f16e0`
|
| 148 |
+
- Verified bit-exact against the training checkpoint it was stripped from: under a fixed seed,
|
| 149 |
+
the two produce an identical 256-d style vector and identical waveform samples, so the strip
|
| 150 |
+
provably changes no output
|
| 151 |
+
|
| 152 |
+
Full details in `manifest.json`.
|
| 153 |
+
|
| 154 |
## Citation
|
| 155 |
|
| 156 |
+
Rosero, Yeo, Mortensen, Van't Slot, Hallac, and Busso. *Generative Reconstruction of Pediatric
|
| 157 |
+
Disordered Speech for Automated Clinical Evaluation.*
|