Update README.md

README.md

@@ -1,3 +1,73 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+tags:
+- biology
+---
+
+# xTrimoPGLM-1B-CLM
+
+## Model Introduction
+
+**xTrimoPGLM-1B-MLM** is the open-source version of the latest masked protein language models designed to prtein understanding tasks. The xTrimoPGLM family models are developed by BioMap and Tsinghua University. Along with this, we have released the int4 quantization xTrimoPGLM-100B weights and other xTrimo-series small models, which include: 1B, 3B, and 10B models trained with masked language modeling for protein understanding, and 1B, 3B, and 7B causal language models aimed at protein design.
+
+### Out-of-Distribution Perplexity Evaluation
+
+We evaluated the xTrimoPGLM-MLM (xTMLM) and xTrimoPGLM(100B) models on two OOD test sets, one with sequence identity lower than 0.9 with the training set (<0.9 ID) and the other with sequence identity lower than 0.5 with the training set (<0.5 ID). Each OOD dataset comprises approximately 10,000 protein sequences. The perplexity results, compared against ESM2-3B and ESM2-15B, are as follows (lower is better):
+
+| Model               | ESM2(3B)| ESM2 (15B) | xTMLM (1B) | xTMLM (3B) | xTMLM (10B) | xT (100B) |
+|:--------------------|:----------:|:----------:|:----------:|:----------:|:--------------------:|:--------------------:|
+| < 0.9 ID           |   7.7   |   7.3    | 9.3    |    7.8    |      7.6    |            **6.7**         | 
+| < 0.5 ID            |  11.5 |  11.0  |  13.5 |   11.9  |   11.6   |         **10.8**          |
+
+
+## Downstream Protein Understanding Tasks Evaluation
+(TODO)
+
+
+## How to use
+```python
+
+# Obtain residue embeddings
+from transformers import AutoModelForMaskedLM, AutoModelForSequenceClassification, AutoModelForTokenClassification, AutoTokenizer, AutoConfig
+import torch
+
+tokenizer  = AutoTokenizer.from_pretrained("biomap-research/xtrimopglm-1b-mlm", trust_remote_code=True, use_fast=True)
+config = AutoConfig.from_pretrained("biomap-research/xtrimopglm-1b-mlm",  trust_remote_code=True, torch_dtype=torch.bfloat16)
+model = AutoModelForMaskedLM.from_config(config, trust_remote_code=True, torch_dtype=torch.bfloat16)
+if torch.cuda.is_available():
+    model = model.cuda()
+model.eval()
+
+seq = 'MILMCQHFSGQFSKYFLAVSSDFCHFVFPIILVSHVNFKQMKRKGFALWNDRAVPFTQGIFTTVMILLQYLHGTG'
+output = tokenizer(seq, add_special_tokens=True, return_tensors='pt')
+with torch.inference_mode():
+    inputs = {"input_ids": output["input_ids"].cuda(), "attention_mask": output["attention_mask"].cuda()}
+    output_embeddings = model(**inputs, output_hidden_states=True, return_last_hidden_state=True).hidden_states[:-1, 0] # get rid of the <eos> token
+
+
+# model for the sequence-level tasks
+model = AutoModelForSequenceClassification.from_config(config, trust_remote_code=True, torch_dtype=torch.bfloat16)
+
+# model for the token-level tasks
+model = AutoModelForTokenClassification.from_config(config, trust_remote_code=True, torch_dtype=torch.bfloat16)
+
+```
+
+
+For more inference or fine-tuning code, datasets, and requirements, please visit our [GitHub page](https://github.com/biomap-research/xTrimoPGLM).
+
+## LICENSE
+
+The code in this repository is open source under the [Apache-2.0 license](./LICENSE).
+
+## Citations
+
+If you find our work useful, please consider citing the following paper:
+```
+@article{chen2024xtrimopglm,
+  title={xTrimoPGLM: unified 100B-scale pre-trained transformer for deciphering the language of protein},
+  author={Chen, Bo and Cheng, Xingyi and Li, Pan and Geng, Yangli-ao and Gong, Jing and Li, Shen and Bei, Zhilei and Tan, Xu and Wang, Boyan and Zeng, Xin and others},
+  journal={arXiv preprint arXiv:2401.06199},
+  year={2024}
+}
+```