Update README.md

README.md

@@ -4,199 +4,190 @@ base_model: microsoft/phi-2
 ---
 
 # Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
+phi-2-mongodb is a fine-tuned version of microsoft/phi-2 to generate MongoDB pipeline queries. It was fine-tuned on a custom curated natural language to MongoDB queries dataset, I'll be releasing that next week.
 
 
 ## Model Details
+Further details about fine-tuned model can be found at : https://github.com/Chirayu-Tripathi/nl2query. It can also be used via nl2query library.
 
 ### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
 
 
+- **Fine-tuned by:** [`Chirayu Tripathi`](http://www.linkedin.com/in/chirayu-tripathi) 
+- **Developed by:** [`Microsoft`]
+- **Language(s) (NLP):** English
+- **License:** MIT
+- **Finetuned from model:** [`microsoft/phi-2`](https://huggingface.co/microsoft/phi-2)
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
+### Prompt Template
+```
+prompt_template = f"""<s> 
+Task Description:
+Your task is to create a MongoDB query that accurately fulfills the provided Instruct while strictly adhering to the given MongoDB schema. Ensure that the query solely relies on keys and columns present in the schema. Minimize the usage of lookup operations wherever feasible to enhance query efficiency.
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+MongoDB Schema: 
+{db_schema}
 
-[More Information Needed]
+### Instruct:
+{text}
 
-### Out-of-Scope Use
+### Output:
+"""
+```
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
-### Framework versions
+Use the code sample provided in the original post to interact with the model.
+```python
+from transformers import (
+    AutoTokenizer,
+    AutoModelForCausalLM,
+    BitsAndBytesConfig,
+)
+import torch
+from peft import PeftModel
+
+db_schema = '''{
+  "collections": [
+    {
+      "name": "shipwrecks",
+      "indexes": [
+        {
+          "key": {
+            "_id": 1
+          }
+        },
+        {
+          "key": {
+            "feature_type": 1
+          }
+        },
+        {
+          "key": {
+            "chart": 1
+          }
+        },
+        {
+          "key": {
+            "latdec": 1,
+            "londec": 1
+          }
+        }
+      ],
+      "uniqueIndexes": [],
+      "document": {
+        "properties": {
+          "_id": {
+            "bsonType": "string"
+          },
+          "recrd": {
+            "bsonType": "string"
+          },
+          "vesslterms": {
+            "bsonType": "string"
+          },
+          "feature_type": {
+            "bsonType": "string"
+          },
+          "chart": {
+            "bsonType": "string"
+          },
+          "latdec": {
+            "bsonType": "double"
+          },
+          "londec": {
+            "bsonType": "double"
+          },
+          "gp_quality": {
+            "bsonType": "string"
+          },
+          "depth": {
+            "bsonType": "string"
+          },
+          "sounding_type": {
+            "bsonType": "string"
+          },
+          "history": {
+            "bsonType": "string"
+          },
+          "quasou": {
+            "bsonType": "string"
+          },
+          "watlev": {
+            "bsonType": "string"
+          },
+          "coordinates": {
+            "bsonType": "array",
+            "items": {
+              "bsonType": "double"
+            }
+          }
+        }
+      }
+    }
+  ],
+  "version": 1
+}'''
+
+text = ''''Find the count of shipwrecks for each unique combination of "latdec" and "longdec"'''
+prompt = f"""<s> 
+        Task Description:
+        Your task is to create a MongoDB query that accurately fulfills the provided Instruct while strictly adhering to the given MongoDB schema. Ensure that the query solely relies on keys and columns present in the schema. Minimize the usage of lookup operations wherever feasible to enhance query efficiency.
+
+        MongoDB Schema: 
+        {db_schema}
+
+        ### Instruct:
+        {text}
+
+        ### Output:
+        """
+
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+base_model_id = "microsoft/phi-2"
+tokenizer = AutoTokenizer.from_pretrained(base_model_id, use_fast=True)
+compute_dtype = getattr(torch, "float16")
+bnb_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_compute_dtype=compute_dtype,
+    bnb_4bit_use_double_quant=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+    base_model_id,
+    trust_remote_code=True,
+    quantization_config=bnb_config,
+    revision="refs/pr/23",
+    device_map={"": 0},
+    torch_dtype="auto",
+    flash_attn=True,
+    flash_rotary=True,
+    fused_dense=True,
+)
+adapter = 'Chirayu/phi-2-mongodb'
+
+model = PeftModel.from_pretrained(model, adapter).to(device)
+model_inputs = tokenizer(prompt, return_tensors="pt").to(device)
+output = model.generate(
+    **model_inputs,
+    max_length=1024,
+    no_repeat_ngram_size=10,
+    repetition_penalty=1.02,
+    pad_token_id=tokenizer.eos_token_id,
+    eos_token_id=tokenizer.eos_token_id,
+)[0]
+
+prompt_length = model_inputs['input_ids'].shape[1]
+query = tokenizer.decode(output[prompt_length:], skip_special_tokens=False)
+try:
+    stop_idx = query.index("</s>")
+except Exception as e:
+    print(e)
+    stop_idx = len(query)
+print(query[: stop_idx].strip())
+```
 
 - PEFT 0.10.0