VAGOsolutions
/

SauerkrautTTS-Preview-0.1

@@ -2,199 +2,74 @@
 library_name: transformers
 tags:
 - unsloth
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 library_name: transformers
 tags:
 - unsloth
+license: cc-by-nc-4.0
+language:
+- de
+base_model:
+- canopylabs/orpheus-3b-0.1-ft
+pipeline_tag: text-to-speech
 ---
+# SauerkrautTTS-Preview-0.1
+![SauerkrautTTS-Preview-0.1](https://vago-solutions.ai/wp-content/uploads/2025/03/SauerkrautTTS.png)
+**SauerkrautTTS-Preview-0.1** is a fine-tuned multilingual Text-to-Speech (TTS) model based on the powerful [canopylabs/orpheus-3b-0.1-ft](https://huggingface.co/canopylabs/orpheus-3b-0.1-ft).
+This preview model introduces four distinct German-speaking voices—**Lena**, **Anna**, **Max**, and **Tom**—crafted using original audio recordings captured with a Rhode Studio microphone and Mimic Studio, alongside carefully curated synthetic data. Despite the limited amount of original recordings, the high-quality synthetic data significantly enhances the clarity and naturalness of the generated speech.
+# Example Output and Comparison
+<video width="600" controls>
+  <source src="https://vago-solutions.ai/wp-content/uploads/2025/03/SauerkrautTTS.mp4" type="video/mp4">
+  Dein Browser unterstützt keine Videoanzeige.
+</video>
+## Model Details
+- **Base Model:** [canopylabs/orpheus-3b-0.1-ft](https://huggingface.co/canopylabs/orpheus-3b-0.1-ft)
+- **Languages Supported:** German
+- **License:** CC BY 4.0
+- **Model Version:** Preview 0.1 (initial release)
+## Speaker Data Breakdown
+| Speaker | Original Data (Hours) | Synthetic Data (Hours) | Total (Hours) |
+|---------|-----------------------|------------------------|---------------|
+| Tom     | 1h                    | 3.8h                   | 4.8h          |
+| Anna    | 3h                    | 1.25h                  | 4.25h         |
+| Max     | -                     | 4.78h                  | 4.78h         |
+| Lena    | -                     | 4.87h                  | 4.87h         |
+The synthetic audio data significantly enriches the model, resulting in versatile and expressive voice capabilities.
+## Usage
+For seamless inference and practical examples, check out our detailed instructions and ready-to-use scripts available on:
+- **Colab Notebook:** [Orpheus Colab](https://colab.research.google.com/drive/1KhXT56UePPUHhqitJNUxq63k-pQomz3N?usp=sharing)
+- **GitHub Repository:** [Orpheus GitHub](https://github.com/canopyai/Orpheus-TTS)
+To achieve optimal results, we recommend using a **lower temperature** for clear and stable outputs. Higher temperatures will enhance dynamism and expressiveness but might introduce instability.
+Example inference settings:
+```python
+temperature = 0.5  # Adjust lower for clearer output, higher for creativity
+```
+## Future Plans
+This model represents our first exploratory step into advanced German-language TTS. Expect significant improvements in upcoming versions, including:
+- Enhanced voice clarity
+- Expanded speaker diversity
+- Greater stability across temperature ranges
+Stay tuned for future releases and updates!
+## License
+SauerkrautTTS-Preview-0.1 is openly available under the [CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/), encouraging reuse, remixing, and improvements by the community.
+## Acknowledgments
+We thank [Unsloth](https://unsloth.ai) for their invaluable training script, which we utilized in a lightly modified form for training this model.