Update README.md

README.md

@@ -1,3 +1,66 @@
----
-license: apache-2.0
----
+---
+base_model: PLM-Team/PLM-1.8B-Base
+language:
+- en
+library_name: transformers
+license: mit
+quantized_by: PLM-Team
+---
+<center>
+<img src="https://www.cdeng.net/plm/plm_logo.png" alt="k2-logo" width="200"/>
+<h2>🖲️ PLM: Efficient Peripheral Language Models Hardware-Co-Designed for Ubiquitous Computing</h2>
+<a href='https://sites.google.com/view/project-plm'>👉 Project PLM Website</a>
+</center>
+
+<center>
+  
+||||||||
+|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
+|<a href='https://arxiv.org/abs/2503.12167'><img src='https://img.shields.io/badge/Paper-ArXiv-C71585'></a>|<a href='https://huggingface.co/PLM-Team/PLM-1.8B-Base'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging Face-Base-red'></a>|<a href='https://huggingface.co/PLM-Team/PLM-1.8B-Instruct'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging Face-Instruct-red'></a>|<a href='https://huggingface.co/PLM-Team/PLM-1.8B-Instruct-gguf'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging Face-gguf-red'></a>|<a href='https://huggingface.co/datasets/plm-team/scots'><img src='https://img.shields.io/badge/Data-plm%20mix-4169E1'></img></a>|<a><img src="https://img.shields.io/github/stars/plm-team/PLM"></a>|
+
+</center>
+
+---
+
+The PLM (Peripheral Language Model) series introduces a novel model architecture to peripheral computing by delivering powerful language capabilities within the constraints of resource-limited devices. Through modeling and system co-design strategy, PLM optimizes model performance and fits edge system requirements, PLM employs **Multi-head Latent Attention** and **squared ReLU** activation to achieve sparsity, significantly reducing memory footprint and computational demands. Coupled with a meticulously crafted training regimen using curated datasets and a Warmup-Stable-Decay-Constant learning rate scheduler, PLM demonstrates superior performance compared to existing small language models, all while maintaining the lowest activated parameters, making it ideally suited for deployment on diverse peripheral platforms like mobile phones and Raspberry Pis.
+
+
+**Here we present the static quants for identified model of PLM-1.8B-Instruct**
+
+## Usage (llama.cpp)
+
+The original contribution to the llama.cpp framwork is [Si1w/llama.cpp](https://github.com/Si1w/llama.cpp). Here is the usage:
+
+```bash
+git clone https://github.com/Si1w/llama.cpp.git
+cd llama.cpp
+pip install -r requirements.txt
+```
+
+Then, we can build with CPU of GPU (e.g. Orin). The build is based on `cmake`. 
+
+- For CPU
+
+```bash
+cmake -B build
+cmake --build build --config Release
+```
+
+- For GPU
+
+```bash
+cmake -B build -DGGML_CUDA=ON
+cmake --build build --config Release
+```
+
+Don't forget to download the GGUF files of the PLM. We use the quantization methods in `llama.cpp` to generate the quantized PLM.
+
+```bash
+huggingface-cli download --resume-download PLM-Team/PLM-1.8B-Instruct-gguf --local-dir PLM-Team/PLM-1.8B-Instruct-gguf
+```
+
+After build the `llama.cpp`, we can use `llama-cli` script to launch the PLM.
+
+```bash
+./build/bin/llama-cli -m ./PLM-Team/PLM-1.8B-Instruct-gguf/PLM-1.8B-Instruct-Q8_0.gguf -cnv -p "hello!" -n 128
+```