Add pipeline tag, library name, and paper link to model card

README.md

@@ -2,7 +2,10 @@
 license: other
 license_name: license
 license_link: LICENSE
+library_name: transformers
+pipeline_tag: text-generation
 ---
+
 <div align="center">
 <h1>
   Index-1.9B-Constant-LR
@@ -12,7 +15,9 @@ license_link: LICENSE
 ## Model Introduction
 This repository Index-1.9B-Constant-LR is the checkpoint file of the [Index-1.9B](https://huggingface.co/IndexTeam/Index-1.9B) base model before decay training, which is provided for everyone to conduct research on downstream tasks.
 
-For more details, see our [GitHub](https://github.com/bilibili/Index-1.9B) and [Index-1.9B Technical Report](https://github.com/bilibili/Index-1.9B/blob/main/Index-1.9B%20%E6%8A%80%E6%9C%AF%E6%8A%A5%E5%91%8A.pdf)
+It is presented in the paper [Index SLM Technical Report](https://huggingface.co/papers/2607.09885).
+
+For more details, see our [GitHub](https://github.com/bilibili/Index-1.9B) and [Index-1.9B Technical Report](https://github.com/bilibili/Index-1.9B/blob/main/Index-1.9B%20%E6%8A%80%E6%9C%AF%E6%8A%A5%E5%91%8A.pdf).
 
 ## Evaluation Results
 Here we add the evaluation of the general understanding ability of the Index-1.9B-Constant-LR model
@@ -23,3 +28,51 @@ Here we add the evaluation of the general understanding ability of the Index-1.9
 |**Index-1.9B**|**64.92** |**69.93**|52.53|57.01|52.79|80.69|65.15|81.35|
 
 Evaluation code is based on [OpenCompass](https://github.com/open-compass/opencompass) with compatibility modifications. See the [evaluate](./evaluate/) folder for details.
+
+## How to Use
+
+You can load this model using `transformers` with the following code snippet:
+
+```python
+import argparse
+from transformers import AutoTokenizer, pipeline
+
+# Attention! The directory must not contain "." and can be replaced with "_".
+parser = argparse.ArgumentParser()
+parser.add_argument('--model_path', default="IndexTeam/Index-1.9B-Constant-LR", type=str, help="")
+parser.add_argument('--device', default="cpu", type=str, help="") # also could be "cuda" or "mps" for Apple silicon
+args = parser.parse_args()
+
+tokenizer = AutoTokenizer.from_pretrained(args.model_path, trust_remote_code=True)
+generator = pipeline("text-generation",
+                    model=args.model_path,
+                    tokenizer=tokenizer, trust_remote_code=True, 
+                    device=args.device)
+
+
+system_message = "你是由哔哩哔哩自主研发的大语言模型，名为“Index”。你能够根据用户传入的信息，帮助用户完成指定的任务，并生成恰当的、符合要求的回复。"
+query = "续写 天不生我金坷垃"
+model_input = []
+model_input.append({"role": "system", "content": system_message})
+model_input.append({"role": "user", "content": query})
+
+model_output = generator(model_input, max_new_tokens=300, top_k=5, top_p=0.8, temperature=0.3, repetition_penalty=1.1, do_sample=True)
+
+print('User:', query)
+print('Model:', model_output)
+```
+
+## Model Open Source License
+
+Using the source code from this repository requires compliance with the [Apache-2.0](LICENSE). The use of the Index-1.9B model weights requires compliance with the [INDEX_MODEL_LICENSE](INDEX_MODEL_LICENSE).
+
+The Index-1.9B model weights are **fully open** for academic research and support **free commercial use**.
+
+## Citation
+
+```bibtex
+@article{Index,
+  title={Index1.9B Technical Report},
+  year={2024}
+}
+```