Update README.md
Browse files
README.md
CHANGED
|
@@ -13,69 +13,34 @@ tags:
|
|
| 13 |
- transformers
|
| 14 |
---
|
| 15 |
|
| 16 |
-
# Model Card for
|
| 17 |
|
| 18 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 19 |
|
| 20 |
|
| 21 |
-
|
| 22 |
## Model Details
|
| 23 |
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
- **Developed by:** [More Information Needed]
|
| 31 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 32 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 33 |
-
- **Model type:** [More Information Needed]
|
| 34 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 35 |
-
- **License:** [More Information Needed]
|
| 36 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 37 |
-
|
| 38 |
-
### Model Sources [optional]
|
| 39 |
-
|
| 40 |
-
<!-- Provide the basic links for the model. -->
|
| 41 |
-
|
| 42 |
-
- **Repository:** [More Information Needed]
|
| 43 |
-
- **Paper [optional]:** [More Information Needed]
|
| 44 |
-
- **Demo [optional]:** [More Information Needed]
|
| 45 |
|
| 46 |
## Uses
|
| 47 |
|
| 48 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 49 |
-
|
| 50 |
### Direct Use
|
| 51 |
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
|
| 56 |
-
### Downstream Use [optional]
|
| 57 |
-
|
| 58 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 59 |
-
|
| 60 |
-
[More Information Needed]
|
| 61 |
-
|
| 62 |
-
### Out-of-Scope Use
|
| 63 |
-
|
| 64 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 65 |
-
|
| 66 |
-
[More Information Needed]
|
| 67 |
|
| 68 |
## Bias, Risks, and Limitations
|
| 69 |
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 77 |
-
|
| 78 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 79 |
|
| 80 |
## How to Get Started with the Model
|
| 81 |
|
|
@@ -132,126 +97,11 @@ sf.write("example.wav", audio, 24000)
|
|
| 132 |
|
| 133 |
### Training Data
|
| 134 |
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
[More Information Needed]
|
| 138 |
-
|
| 139 |
-
### Training Procedure
|
| 140 |
-
|
| 141 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 142 |
-
|
| 143 |
-
#### Preprocessing [optional]
|
| 144 |
-
|
| 145 |
-
[More Information Needed]
|
| 146 |
-
|
| 147 |
-
|
| 148 |
-
#### Training Hyperparameters
|
| 149 |
-
|
| 150 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 151 |
-
|
| 152 |
-
#### Speeds, Sizes, Times [optional]
|
| 153 |
-
|
| 154 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 155 |
-
|
| 156 |
-
[More Information Needed]
|
| 157 |
-
|
| 158 |
-
## Evaluation
|
| 159 |
-
|
| 160 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 161 |
-
|
| 162 |
-
### Testing Data, Factors & Metrics
|
| 163 |
-
|
| 164 |
-
#### Testing Data
|
| 165 |
-
|
| 166 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 167 |
-
|
| 168 |
-
[More Information Needed]
|
| 169 |
-
|
| 170 |
-
#### Factors
|
| 171 |
-
|
| 172 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 173 |
-
|
| 174 |
-
[More Information Needed]
|
| 175 |
-
|
| 176 |
-
#### Metrics
|
| 177 |
-
|
| 178 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 179 |
-
|
| 180 |
-
[More Information Needed]
|
| 181 |
-
|
| 182 |
-
### Results
|
| 183 |
-
|
| 184 |
-
[More Information Needed]
|
| 185 |
-
|
| 186 |
-
#### Summary
|
| 187 |
-
|
| 188 |
-
|
| 189 |
-
|
| 190 |
-
## Model Examination [optional]
|
| 191 |
-
|
| 192 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 193 |
-
|
| 194 |
-
[More Information Needed]
|
| 195 |
-
|
| 196 |
-
## Environmental Impact
|
| 197 |
-
|
| 198 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 199 |
-
|
| 200 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
| 201 |
-
|
| 202 |
-
- **Hardware Type:** [More Information Needed]
|
| 203 |
-
- **Hours used:** [More Information Needed]
|
| 204 |
-
- **Cloud Provider:** [More Information Needed]
|
| 205 |
-
- **Compute Region:** [More Information Needed]
|
| 206 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 207 |
-
|
| 208 |
-
## Technical Specifications [optional]
|
| 209 |
-
|
| 210 |
-
### Model Architecture and Objective
|
| 211 |
-
|
| 212 |
-
[More Information Needed]
|
| 213 |
-
|
| 214 |
-
### Compute Infrastructure
|
| 215 |
-
|
| 216 |
-
[More Information Needed]
|
| 217 |
-
|
| 218 |
-
#### Hardware
|
| 219 |
-
|
| 220 |
-
[More Information Needed]
|
| 221 |
-
|
| 222 |
-
#### Software
|
| 223 |
-
|
| 224 |
-
[More Information Needed]
|
| 225 |
-
|
| 226 |
-
## Citation [optional]
|
| 227 |
-
|
| 228 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 229 |
-
|
| 230 |
-
**BibTeX:**
|
| 231 |
-
|
| 232 |
-
[More Information Needed]
|
| 233 |
-
|
| 234 |
-
**APA:**
|
| 235 |
-
|
| 236 |
-
[More Information Needed]
|
| 237 |
-
|
| 238 |
-
## Glossary [optional]
|
| 239 |
-
|
| 240 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 241 |
-
|
| 242 |
-
[More Information Needed]
|
| 243 |
-
|
| 244 |
-
## More Information [optional]
|
| 245 |
-
|
| 246 |
-
[More Information Needed]
|
| 247 |
-
|
| 248 |
-
## Model Card Authors [optional]
|
| 249 |
|
| 250 |
-
|
| 251 |
|
| 252 |
-
## Model Card Contact
|
| 253 |
|
| 254 |
-
[More Information Needed]
|
| 255 |
### Framework versions
|
| 256 |
|
| 257 |
- PEFT 0.15.2
|
|
|
|
| 13 |
- transformers
|
| 14 |
---
|
| 15 |
|
| 16 |
+
# Model Card for Cardiology-TTS
|
| 17 |
|
| 18 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 19 |
|
| 20 |
|
|
|
|
| 21 |
## Model Details
|
| 22 |
|
| 23 |
+
This is a fine-tuned version of the Conversational Speech Model (CSM-1B) using LoRA for parameter-efficient fine-tuning.
|
| 24 |
+
The model is trained on a 1,530-sample dataset of medical cardiology texts, designed to generate high-quality speech from cardiology-related text.
|
| 25 |
+
It leverages the capabilities of the original CSM-1B model for text-to-speech synthesis, extended with domain-specific terminology for medical cardiology.
|
| 26 |
+
It is intended for speech generation in English, especially for clinical and educational contexts.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
|
| 28 |
## Uses
|
| 29 |
|
|
|
|
|
|
|
| 30 |
### Direct Use
|
| 31 |
|
| 32 |
+
- Text-to-Speech (TTS) generation for cardiology educational content, medical reports, or clinical explanations.
|
| 33 |
+
- Integrating spoken content in healthcare apps, e-learning platforms, or patient-facing tools for cardiology topics.
|
| 34 |
+
- Research and prototyping domain-specific TTS applications using small medical datasets.
|
| 35 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
## Bias, Risks, and Limitations
|
| 38 |
|
| 39 |
+
- Small training dataset (2K samples) → Model may not generalize well to rare medical terms, long passages, or other medical domains outside cardiology.
|
| 40 |
+
- English-only support → Model is not trained for other languages.
|
| 41 |
+
- TTS artifacts → Some generated audio may contain unnatural pauses, mispronunciations, or clipping in challenging sentences.
|
| 42 |
+
- Not for diagnostic purposes → Model outputs speech for educational/illustrative purposes and should not be used for medical diagnosis or patient instructions.
|
| 43 |
+
- Model size and resources → CSM-1B is large; requires GPU for real-time inference and significant VRAM for batch synthesis.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
## How to Get Started with the Model
|
| 46 |
|
|
|
|
| 97 |
|
| 98 |
### Training Data
|
| 99 |
|
| 100 |
+
- Dataset: Dev372/Cardiology_Medical_STT_Dataset
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 101 |
|
| 102 |
+
1,530 samples of cardiology-related text paired with audio.
|
| 103 |
|
|
|
|
| 104 |
|
|
|
|
| 105 |
### Framework versions
|
| 106 |
|
| 107 |
- PEFT 0.15.2
|