Update README.md

README.md

@@ -1,199 +1,116 @@
----
-library_name: transformers
-tags: []
----
-
-# 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
+# TinyWave Base Speech 2B
 
-### Training Data
+**TinyWave Base Speech 2B** is a compact speech-to-speech generation model distilled from the 7B SPIRIT-LM-Base teacher. It uses HuBERT-based phonetic tokens for efficient, high-quality speech generation and is optimized for **fast inference** on **commodity hardware**.
 
-<!-- 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
+This model focuses on generating semantically coherent speech continuations without expressive modulation (e.g., pitch/style tokens). It is ideal for **low-resource speech agents**, **instruction-following speech bots**, and **embedded systems**.
 
+> 📖 See the [TinyWave paper (arXiv:2506.23670)](https://arxiv.org/abs/2506.23670) and [demo site](https://mohammadmahdinoori.github.io/tinywave-landing/) for more details.
 
+---
 
-## Model Examination [optional]
+## 🔧 Usage
 
-<!-- Relevant interpretability work for the model goes here -->
+This model requires **SPIRIT-LM's base speech tokenizer**, which uses HuBERT units without pitch/style tokens.
 
-[More Information Needed]
+### 1. Clone SPIRIT-LM and Install Requirements
 
-## Environmental Impact
+```bash
+git clone https://github.com/facebookresearch/spiritlm
+cd spiritlm
+pip install -e '.[eval]'
+````
 
-<!-- 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).
+### 2. Load Tokenizer
 
-- **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]
+```python
+from spiritlm.speech_tokenizer import spiritlm_base
+speech_tokenizer = spiritlm_base()
+```
 
-## Technical Specifications [optional]
+---
 
-### Model Architecture and Objective
+### 3. Inference Code (Speech-to-Speech)
 
-[More Information Needed]
+```python
+from transformers import LlamaForCausalLM, AutoTokenizer
+import torchaudio
+import torch
 
-### Compute Infrastructure
+# Load model and tokenizer
+MODEL_PATH = "tinywave/speech-base-2b"
+tokenizer = AutoTokenizer.from_pretrained(MODEL_PATH)
+model = LlamaForCausalLM.from_pretrained(MODEL_PATH, device_map="auto", torch_dtype=torch.bfloat16)
 
-[More Information Needed]
+# Load base speech tokenizer
+speech_tokenizer = spiritlm_base()
 
-#### Hardware
+def get_inference(audio_path):
+    audio, _ = torchaudio.load(audio_path)
+    input_values = audio.view(1, 1, -1).to(speech_tokenizer.hubert_model.device).float()
+    tokens = speech_tokenizer.encode_string(input_values)
+    input_ids = tokenizer(tokens, return_tensors="pt").input_ids.to(model.device)
+    output = model.generate(input_ids, max_new_tokens=256, top_p=0.9, temperature=0.9, do_sample=True)
+    return tokenizer.decode(output[0])
+```
 
-[More Information Needed]
+---
 
-#### Software
+### 4. Decode to WAV
 
-[More Information Needed]
+```python
+import numpy as np
+from scipy.io.wavfile import write
 
-## Citation [optional]
+def save_array_to_wav_int16(audio_array: np.ndarray, sampling_rate=16000, filename="output.wav"):
+    scaled = np.int16(audio_array / np.max(np.abs(audio_array)) * 32767)
+    write(filename, sampling_rate, scaled)
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+decoded_audio = speech_tokenizer.decode(generated_output.replace(" ", "").replace("<s>", "").replace("</s>", ""), speaker_id=2)
+save_array_to_wav_int16(decoded_audio, filename="generated.wav")
+```
 
-**BibTeX:**
+---
 
-[More Information Needed]
+## 🗣️ Inference Example
 
-**APA:**
+### 🎧 Basic Speech Continuation
 
-[More Information Needed]
+Input: `simple_prompt.wav`
+Output: Semantically consistent speech continuation without expressive variation.
 
-## Glossary [optional]
+---
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## 🧠 Model Details
 
-[More Information Needed]
+| Feature             | Description                                      |
+| ------------------- | ------------------------------------------------ |
+| Architecture        | 2B parameter distilled transformer               |
+| Tokenizer           | SPIRIT-LM Base (HuBERT phonetic tokens)          |
+| Input Type          | Discrete HuBERT tokens only (speech-only)        |
+| Output Type         | Discrete audio tokens                            |
+| Teacher Model       | SPIRIT-LM-Base 7B                                |
+| Tasks               | Speech continuation                              |
+| Distillation Method | Layer-aligned (hidden states, attention, logits) |
 
-## More Information [optional]
+---
 
-[More Information Needed]
+## 📎 Citation
 
-## Model Card Authors [optional]
+```bibtex
+@article{nouriborji2025tinywave,
+  title={Efficient Interleaved Speech Modeling through Knowledge Distillation},
+  author={Nouriborji, Mohammadmahdi and Rohanian, Morteza},
+  journal={arXiv preprint arXiv:2506.23670},
+  year={2025}
+}
+```
 
-[More Information Needed]
+---
 
-## Model Card Contact
+## 📂 Resources
 
-[More Information Needed]
+* 🔗 [Project Page](https://mohammadmahdinoori.github.io/tinywave-landing/)
+* 💬 [Demo Samples](https://mohammadmahdinoori.github.io/tinywave-landing/#samples)
+* 🧠 [Training & Codebase](https://github.com/mohammadmahdinoori/TinyWave)