Update README.md

README.md

@@ -1,3 +1,33 @@
----
-license: mit
----
+---
+license: mit
+---
+
+## VHHBERT
+
+VHHBERT is a RoBERTa-based model pre-trained on two million VHH sequences in [VHHCorpus-2M](https://huggingface.co/datasets/COGNANO/VHHCorpus-2M).
+VHHBERT has the same model parameters as RoBERTa<sub>BASE</sub>, except that it used positional embeddings with a length of 185 to cover the maximum sequence length of 179 in VHHCorpus-2M.
+Further details on VHHBERT are described in our paper "A SARS-CoV-2 Interaction Dataset and VHH Sequence Corpus for Antibody Language Models.”
+
+## Usage
+
+The model and tokenizer can be loaded using the `transformers` library.
+
+```python
+from transformers import BertTokenizer, RobertaModel
+tokenizer = BertTokenizer.from_pretrained("tsurubee/VHHBERT")
+model = RobertaModel.from_pretrained("tsurubee/VHHBERT")
+```
+
+## Links
+
+- Pre-training Corpus: https://huggingface.co/datasets/COGNANO/VHHCorpus-2M
+- Code: https://github.com/cognano/AVIDa-SARS-CoV-2
+- Paper: TBD
+
+## Citation
+
+If you use VHHBERT in your research, please cite the following paper.
+
+```bibtex
+TBD
+```