Update README.md

README.md

@@ -15,8 +15,7 @@ pipeline_tag: text-generation
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
+Smile model nderstands the indian nunaces & give more accurate responses wrt. indian context
 
 
 ## Model Details
@@ -27,31 +26,30 @@ pipeline_tag: text-generation
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **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]
+- **Developed by:** 
+- **Funded by [optional]:** https://github.com/ombhojane
+- **Model type:** Quantized
+- **Language(s) (NLP):** Python, Unsloth
+- **License:** MIT
+- **Finetuned from model [optional]:** Qwen/Qwen2.5-1.5B-Instruct
 
 ### 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
+- **Repository:** https://github.com/ombhojane/smile
+- **Paper [optional]:** On it, buildin'
+- **Demo [optional]:** https://smilecrm.vercel.app/
 
+<!-- ## 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
-
+<!-- ### Direct Use
+ -->
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 ```
-from transformers import pipeline
+<!-- from transformers import pipeline
 import torch
 
 messages = [
@@ -70,53 +68,57 @@ print(generated_text)
 ```
 generated_text[0]['generated_text'][1]['content']
 ```
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
+ -->
+<!-- [More Information Needed]
+ -->
+<!-- ### Downstream Use [optional]
+ -->
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 ### Out-of-Scope Use
-
+ -->
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
-
+<!-- [More Information Needed]
+ -->
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
-
-### Recommendations
+Parent model is equivalent to a SLM - might lags in some speacial areas
 
+<!-- [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
+<!-- ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
 [More Information Needed]
-
+ -->
 ## Training Details
 
 ### Training Data
 
+https://huggingface.co/datasets/ombhojane/smile-india
+
 <!-- 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]
+<!-- [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]
+<!-- #### Preprocessing [optional]
 
 [More Information Needed]
 
@@ -125,35 +127,35 @@ Use the code below to get started with the model.
 
 - **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]
+<!-- #### Speeds, Sizes, Times [optional]
+ -->
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. --> -->
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+<!-- [More Information Needed]
 
 ## Evaluation
-
+ -->
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics
 
 #### Testing Data
-
+ -->
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 #### Factors
-
+ -->
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 #### Metrics
-
+ -->
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
 ### Results
 
@@ -161,19 +163,19 @@ Use the code below to get started with the model.
 
 #### Summary
 
+ -->
 
-
-## Model Examination [optional]
-
+<!-- ## Model Examination [optional]
+ -->
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [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).
+<!-- 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]
@@ -197,12 +199,12 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Software
 
-[More Information Needed]
-
+[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. -->
-
+<!-- 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]
@@ -212,10 +214,10 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 [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 Needed]
 
 ## More Information [optional]
 
@@ -227,4 +229,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->