edwko commited on
Commit
16ca1c6
·
verified ·
1 Parent(s): 9b27a16

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -17
README.md CHANGED
@@ -66,22 +66,18 @@ pipeline_tag: text-to-speech
66
  </div>
67
 
68
  > [!IMPORTANT]
69
- > **Important Sampling Considerations Across Different Backends**
70
- >
71
- > **OuteTTS Version 1.0** supports multiple backends; however, since each handles sampling differently,
72
- > **llama.cpp** delivers the most reliable and consistent output quality by default.
73
- > For optimal results, I recommend using the **llama.cpp** backend with this model.
74
- >
75
- > I also strongly recommend using the model with the specified settings [here](#sampling-configuration).
76
- > Deviating from these settings may result in low quality or broken outputs.
77
- > This issue stems primarily from how different backends implement the **repetition penalty**.
78
- > This model performs best with a **windowed approach** (using a **64-token window**), where the penalty is applied only to the most recent tokens, rather than across the entire context window.
79
- >
80
- > **Llama.cpp** and **EXL2** support such sampling, while **Transformers** don't.
81
- > To address this, I've implemented a **windowed repetition penalty** for the **Hugging Face Transformers** backend in the **OuteTTS** library, which significantly improves output quality and resolves sampling issues, providing comparable results to llama.cpp.
82
- > Without this adjustment, output quality may suffer considerably.
83
- >
84
- > If you've found alternative sampling settings that improve performance, please share your findings by opening an issue on the [OuteTTS GitHub](https://github.com/edwko/OuteTTS/issues).
85
 
86
  # OuteTTS Version 1.0
87
 
@@ -211,7 +207,7 @@ For optimal results with this TTS model, use the following sampling settings.
211
  |-------------------|----------|
212
  | Temperature | 0.4 |
213
  | Repetition Penalty| 1.1 |
214
- | Repetition Range | 64 |
215
  | Top-k | 40 |
216
  | Top-p | 0.9 |
217
  | Min-p | 0.05 |
 
66
  </div>
67
 
68
  > [!IMPORTANT]
69
+ > **Important Sampling Considerations**
70
+ >
71
+ > When using OuteTTS version 1.0, it is crucial to use the settings specified in the [Sampling Configuration](#sampling-configuration) section.
72
+ >
73
+ > The **repetition penalty implementation** is particularly important - this model requires penalization applied to a **64-token recent window**,
74
+ > rather than across the entire context window. Penalizing the entire context will cause the model to produce **broken or low-quality output**.
75
+ >
76
+ > Currently, **llama.cpp** delivers the most reliable and consistent output quality by default.
77
+ > Both **llama.cpp** and **EXL2** support this windowed sampling approach, while **Transformers** doesn't.
78
+ >
79
+ > To address this limitation, I've implemented a **windowed repetition penalty** for the **Hugging Face Transformers** backend in the **OuteTTS** library,
80
+ > which significantly improves output quality and resolves sampling issues, providing comparable results to llama.cpp.
 
 
 
 
81
 
82
  # OuteTTS Version 1.0
83
 
 
207
  |-------------------|----------|
208
  | Temperature | 0.4 |
209
  | Repetition Penalty| 1.1 |
210
+ | **Repetition Range** | **64** |
211
  | Top-k | 40 |
212
  | Top-p | 0.9 |
213
  | Min-p | 0.05 |