Update README.md

README.md

@@ -1,11 +1,15 @@
 ---
 library_name: transformers
-tags: []
+license: mit
+datasets:
+- openslr/librispeech_asr
+- slprl/sTinyStories2
+base_model:
+- Qwen/Qwen2.5-0.5B
 ---
 
 # Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
+This is a Speech Lanaguage Model trained for generating audio contiuations over discrete [Hubert tokens](https://huggingface.co/slprl/mhubert-base-25hz).
 
 
 
@@ -17,25 +21,19 @@ tags: []
 
 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]
+- **Developed by:** [SLP-RL](https://huggingface.co/slprl)
+- **Model type:** SpeechLM
+- **License:** MIT
+- **Finetuned from model:** [Qwen/Qwen2.5-0.5B](https://huggingface.co/Qwen/Qwen2.5-0.5B)
 
-<!-- Provide the basic links for the model. -->
+### Model Sources
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [https://github.com/slp-rl/slam](https://github.com/slp-rl/slam)
+- **Paper:** [Soon!]
+- **Demo:** [Link](https://pages.cs.huji.ac.il/adiyoss-lab/slamming/)
 
 ## 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. -->
+This is a base SpeechLM and as such can be used to generate contiuations for speech segments, or as base for further tuning.
 
 ### Direct Use
 
@@ -43,17 +41,9 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 [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 model was trained on curated speech datasets which contain mainly audio-books and stories, as such the outputs should not be treated as factual in any way.
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
 
 ## Bias, Risks, and Limitations
 
@@ -69,25 +59,25 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
+We refer users to the official repository for full usage explainations - [github](https://github.com/slp-rl/slam).
 
-[More Information Needed]
 
 ## Training Details
+We highly encourage users to read the full [paper](), for full 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]
+This model was trained on a subset of [LibriSpeech] train, [Libri-Light]() and the synthetic dataset
+[sTinyStories](https://huggingface.co/datasets/slprl/sTinyStories) for the pre-training phase. It was also trained with DPO on the synthetic
+dataset [SpokenSwag](https://huggingface.co/datasets/slprl/SpokenSwag).
 
 ### 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]
+#### Preprocessing
+Speech tokens are extracted from the audio using [Hubert-25hz](https://huggingface.co/slprl/mhubert-base-25hz), and quantised using the 
+official kmeans released with the model in [textlesslib](https://github.com/facebookresearch/textlesslib/tree/main). Units are de-duplicated.
+We encourage you to explore the official repository for full details - [github](https://github.com/slp-rl/slam).
 
 
 #### Training Hyperparameters
@@ -132,68 +122,24 @@ Use the code below to get started with the model.
 
 
 
-## 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]
+This model was trained as part of ["*Slamming*: Training a Speech Language Model on One GPU in a Day"], focusing on efficient training.
 
 #### Hardware
-
-[More Information Needed]
+This model was trained using **only a single Nvidia A5000 GPU**, 16 CPU cores and 24 GB of RAM for **24 hours**.
 
 #### Software
+The model was trained using the [*Slam*](https://github.com/slp-rl/slam) codebase which builds upon transformers extending it to support easy and efficent training of
+Speech Language Models.
 
-[More Information Needed]
-
-## Citation [optional]
+## Citation
 
 <!-- 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]
+Soon!