Update README.md

README.md

@@ -1,199 +1,129 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- falcon-h1
+- edge
+license: other
+license_name: falcon-llm-license
+license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
 ---
 
-# Model Card for Model ID
+<img src="https://cdn-uploads.huggingface.co/production/uploads/62441d1d9fdefb55a0b7d12c/l1du02RjuAZJcksI5tQ-F.png" alt="drawing" width="800"/>
 
-<!-- Provide a quick summary of what the model is/does. -->
+#  Table of Contents
 
+0. [TL;DR](#TL;DR)
+1. [Model Details](#model-details)
+2. [Training Details](#training-details)
+3. [Usage](#usage)
+4. [Evaluation](#evaluation)
+5. [Citation](#citation)
 
+# TL;DR
 
-## Model Details
+# Model Details
 
-### Model Description
+## Model Description
 
-<!-- Provide a longer summary of what this model is. -->
+- **Developed by:** [https://www.tii.ae](https://www.tii.ae)
+- **Model type:** Causal decoder-only
+- **Architecture:** Hybrid Transformers + Mamba architecture
+- **Language(s) (NLP):** English
+- **Number of Parameters:** 90M
+- **License:** Falcon-LLM License
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+# Training details
 
-- **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]
+For more details about the training protocol of this model, please refer to the [Tiny-H1 technical blogpost](https://huggingface.co/spaces/tiiuae/tiny-h1-blogpost).
 
-### Model Sources [optional]
+# Usage
 
-<!-- Provide the basic links for the model. -->
+Currently to use this model you can either rely on Hugging Face `transformers`, `vLLM`, `sglang`, `llama.cpp`, `ollama` or `mlx` library.
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+## Inference
 
-## Uses
+### 🤗 transformers
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+Refer to the snippet below to run H1 models using 🤗 transformers:
 
-### Direct Use
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+model_id = "tiiuae/Falcon-H1R-0.6B"
 
-[More Information Needed]
+model = AutoModelForCausalLM.from_pretrained(
+  model_id,
+  torch_dtype=torch.bfloat16,
+  device_map="auto"
+)
 
-### Downstream Use [optional]
+# Perform text generation
+```
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+or
 
-[More Information Needed]
+```bash
+transformers serve tiiuae/Falcon-H1R-0.6B
+```
 
-### Out-of-Scope Use
+### `llama.cpp`
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+You can find all GGUF files compatible with `llama.cpp` under [our official collection]() - an example setup could be:
 
-[More Information Needed]
+```bash
+brew install llama.cpp 
+pip install huggingface_hub 
+hf download tiiuae/Falcon-H1R-0.6B Falcon-H1R-0.6B-Q8_0.gguf --local-dir ./ 
+llama-cli ./ Falcon-H1R-0.6B-Q8_0.gguf -cnv 
+```
 
-## Bias, Risks, and Limitations
+### `ollama`
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+```bash
+ollama run hf.co/tiiuae/Falcon-H1R-0.6B:Q8_0 
+```
 
-[More Information Needed]
+### Apple `mlx` 
 
-### Recommendations
+```bash
+mlx_lm.chat --model tiiuae/Tiny-H1-SF 
+```
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+### vLLM
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+For vLLM, simply start a server by executing the command below:
 
-## How to Get Started with the Model
+```bash
+# pip install vllm>=0.9.0
+vllm serve tiiuae/Falcon-H1R-0.6B --tensor-parallel-size 2 --data-parallel-size 1
+```
 
-Use the code below to get started with the model.
+### sglang
 
-[More Information Needed]
+```bash
+python -m sglang.launch_server \
+  --model ttiiuae/Falcon-H1R-0.6B \
+  --tensor-parallel-size 1 
+```
 
-## Training Details
+# Evaluation
 
-### Training Data
+For detailed evaluation of Tiny-H1 series, please refer to our [technical blogpost](https://huggingface.co/spaces/tiiuae/tiny-h1-blogpost)
 
-<!-- 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. -->
+# Useful links
 
-[More Information Needed]
+- View [our release blogpost]([https://falcon-lm.github.io/blog/falcon-h1/](https://huggingface.co/spaces/tiiuae/tiny-h1-blogpost)).
+- Feel free to join [our discord server](https://discord.gg/trwMYP9PYm) if you have any questions or to interact with our researchers and developers.
 
-### Training Procedure
+# Citation
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+If the Tiny-H1 family of models were helpful to your work, feel free to give us a cite.
 
-#### 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]
+```
+@misc{team2025_tiny_h1_a_series_of_extremely_small_yet_powerful_language_models_redefining_capabilities_at_small_scale,
+  title={Tiny-H1: A series of extremely small, yet powerful language models redefining capabilities at small scale},
+  author={Falcon-LLM Team},
+  year={2025}, 
+}
+```