Update README.md

README.md

@@ -7,30 +7,24 @@ tags:
 - sentence-transformers
 - sentence-similarity
 - feature-extraction
+- UniHGKR
 widget: []
 ---
 
-# SentenceTransformer
+# UniHGKR-base-beir
 
-This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
+The UniHGKR-base-beir model is derived from the UniHGKR-base model, further fine-tuned on MS MARCO for evaluation on the BEIR benchmark. We recommend using the [sentence-transformers](https://www.SBERT.net) package to load our model and to perform embedding for paragraphs and sentences.
 
-## Model Details
+It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
 
-### Model Description
-- **Model Type:** Sentence Transformer
-<!-- - **Base model:** [Unknown](https://huggingface.co/unknown) -->
-- **Maximum Sequence Length:** 512 tokens
-- **Output Dimensionality:** 768 tokens
-- **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
 
-### Model Sources
+## Evaluation on BEIR
+
+The evaluation code can be found at https://github.com/ZhishanQ/UniHGKR.
+
+
+## Model Details
 
-- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
-- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
-- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
 
 ### Full Model Architecture
 
@@ -121,6 +115,13 @@ You can finetune this model on your own dataset.
 - Datasets: 2.21.0
 - Tokenizers: 0.19.1
 
+### Sentence Transformers Sources
+
+- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
+- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
+- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
+
+
 ## Citation
 
 ### BibTeX