Update README.md

README.md

@@ -1,3 +1,45 @@
----
-license: mit
----
+---
+license: apache-2.0
+language:
+- en
+base_model:
+- facebook/contriever
+---
+
+OpenScholar_Retriever is a continued pre-trained version of [facebook/contriever](https://huggingface.co/facebook/contriever) for scientific literature synthesis. 
+
+
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Developed by:** University of Washigton, Allen Institute for AI (AI2)
+- **Model type:** a masked language model. 
+- **Language(s) (NLP):** English
+- **License:** The code and model are released under Apache 2.0.
+- **Date cutoff:** The pre-training data is mixture of [peS2o](https://huggingface.co/datasets/allenai/peS2o), [CCNews](https://huggingface.co/datasets/vblagoje/cc_news) and [Proofpile2](https://huggingface.co/datasets/EleutherAI/proof-pile-2).
+
+### Model Sources
+
+<!-- Provide the basic links for the model. -->
+
+- **Project Page:** https://open-scholar.allen.ai/
+- **Repositories:** 
+    - Core repo (training, inference, fine-tuning etc.): https://github.com/AkariAsai/OpenScholar
+    - Evaluation code: https://github.com/AkariAsai/ScholarQABench
+- **Paper:** [Link](https://openscholar.allen.ai/paper)
+- **Technical blog post:** https://allenai.org/blog/openscholar
+<!-- - **Press release:** TODO -->
+
+### Citation
+If you find it useful in this work, cite our paper.  
+
+```
+@article{openscholar,
+  title={{OpenScholar}: Synthesizing Scientific Literature with Retrieval-Augmented Language Models},
+  author={ Asai, Akari and He*, Jacqueline and Shao*, Rulin and Shi, Weijia and Singh, Amanpreet and Chang, Joseph Chee  and Lo,  Kyle and Soldaini, Luca and Feldman, Tian, Sergey and Mike, D’arcy and Wadden, David and Latzke, Matt and Minyang and Ji, Pan and Liu, Shengyan and Tong, Hao and Wu, Bohao and Xiong, Yanyu and Zettlemoyer, Luke and Weld, Dan and Neubig, Graham and Downey, Doug and Yih, Wen-tau and Koh, Pang Wei and Hajishirzi, Hannaneh},
+  journal={Arxiv},
+  year={2024},
+}
+```