Update README.md

README.md

@@ -2,5 +2,120 @@
 license: apache-2.0
 language:
 - en
+library_name: sentence-transformers
+tags:
+- earth science
+- climate
+- biology
 pipeline_tag: sentence-similarity
----
+---
+
+# Model Card for nasa-smd-ibm-v0.1
+
+`nasa-smd-ibm-st-v2` is improved version of Bi-encoder sentence transformer model (`nasa-smd-ibm-st`), that is fine-tuned from nasa-smd-ibm-v0.1 encoder model. It's trained with 271 million examples along with a domain-specific dataset of 2.6 million examples from documents curated by NASA Science Mission Directorate (SMD). With this model, we aim to enhance natural language technologies like information retrieval and intelligent search as it applies to SMD NLP applications.
+
+## Model Details
+- **Base Model**: nasa-smd-ibm-v0.1
+- **Tokenizer**: Custom
+- **Parameters**: 125M
+- **Training Strategy**: Sentence Pairs, and score indicating relevancy. The model encodes the two sentence pairs independently and cosine similarity is calculated. the similarity is optimized using the relevance score. 
+- **Distilled Version**: You can download a distilled version of the model (30 Million Parameters) here: https://drive.google.com/file/d/19s2Vv9WlmlRhh_AhzdP-s__0spQCG8cQ/view?usp=sharing
+## Training Data
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/ZjcHW24iKsvUYBhoL7eMM.png)
+Figure: Open dataset sources for sentence transformers (269M in total)
+
+Additionally, 2.6M abstract + title pairs collected from NASA SMD documents.
+
+
+## Training Procedure 
+- **Framework**: PyTorch 1.9.1
+- **sentence-transformers version**: 4.30.2
+- **Strategy**: Sentence Pairs
+
+## Evaluation
+Following models are evaluated:
+
+1. All-MiniLM-l6-v2 [sentence-transformers/all-MiniLM-L6-v2]
+2. BGE-base [BAAI/bge-base-en-v1.5]
+3. RoBERTa-base [roberta-base]
+4. nasa-smd-ibm-rtvr_v0.1 [nasa-impact/nasa-smd-ibm-st]
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/QvuEkZJjDGNllRyzl3Oh6.png)
+
+Figure: BEIR Evaluation Metrics
+
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/J3iuPWaGp_qTbllPFpchi.png)
+
+Figure: Retrieval Benchmark Evaluation
+
+## Uses
+- Information Retrieval
+- Sentence Similarity Search
+- Retrieval Augmented Generation
+
+For NASA SMD related, scientific usecases.
+
+### Usage
+
+```python
+
+from sentence_transformers import SentenceTransformer, util
+model = SentenceTransformer('path_to_model')
+input_queries = [
+'query: how much protein should a female eat', 'query: summit define']
+input_passages = [
+"As a general guideline, the CDC's average requirement of protein for women ages 19 to 70 is 46 grams per day.
+But, as you can see from this chart, you'll need to increase that if you're expecting or training for a marathon. Check out the chart below to see how much protein you should be eating each day.",
+"Definition of summit for English Language Learners. : 1 the highest point of a mountain : the top of a mountain. : 2 the highest level. : 3 a meeting or series of meetings between the leaders of two or more governments."]
+query_embeddings = model.encode(input_queries)
+passage_embeddings = model.encode(input_passages)
+print(util.cos_sim(query_embeddings, passage_embeddings))
+```
+
+## Citation
+If you find this work useful, please cite using the following bibtex citation:
+
+```bibtex
+@misc {nasa-impact_2023,
+	author       = { Aashka Trivedi and Bishwaranjan Bhattacharjee and Muthukumaran Ramasubramanian and Iksha Gurung and Masayasu Maraoka and Rahul Ramachandran and Manil Maskey and Kaylin Bugbee and Mike Little and Elizabeth Fancher and Lauren Sanders and Sylvain Costes and Sergi Blanco-Cuaresma and Kelly Lockhart and Thomas Allen and Felix Grazes and Megan Ansdell and Alberto Accomazzi and Sanaz Vahidinia and Ryan McGranaghan and Armin Mehrabian and Tsendgar Lee},
+	title        = { nasa-smd-ibm-st (Revision 08ac2b4) },
+	year         = 2023,
+	url          = { https://huggingface.co/nasa-impact/nasa-smd-ibm-st },
+	doi          = { 10.57967/hf/1441 },
+	publisher    = { Hugging Face }
+}
+```
+
+## Attribution
+
+IBM Research
+- Aashka Trivedi
+- Masayasu Maraoka
+- Bishwaranjan Bhattacharjee
+
+NASA SMD
+- Muthukumaran Ramasubramanian
+- Iksha Gurung
+- Rahul Ramachandran
+- Manil Maskey
+- Kaylin Bugbee
+- Mike Little
+- Elizabeth Fancher
+- Lauren Sanders
+- Sylvain Costes
+- Sergi Blanco-Cuaresma
+- Kelly Lockhart
+- Thomas Allen
+- Felix Grazes
+- Megan Ansdell
+- Alberto Accomazzi
+- Sanaz Vahidinia
+- Ryan McGranaghan
+- Armin Mehrabian
+- Tsendgar Lee
+
+## Disclaimer
+
+This sentence-transformer model is currently in an experimental phase. We are working to improve the model's capabilities and performance, and as we progress, we invite the community to engage with this model, provide feedback, and contribute to its evolution.