Update README.md

updated all details

README.md

@@ -2,6 +2,15 @@
 library_name: transformers
 tags:
 - unsloth
+- Sparky-SQL-Llama-3.2-1B
+license: apache-2.0
+datasets:
+- shreeyashm/SQL-Queries-Dataset
+language:
+- en
+base_model:
+- unsloth/Llama-3.2-1B
+pipeline_tag: text-generation
 ---
 
 # Model Card for Model ID
@@ -13,74 +22,32 @@ tags:
 ## Model Details
 
 ### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-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]
-
-### 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]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[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]
-
-## 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.
+The model was fintuned from Llama-3.2-1B base model with SQL query data
 
 ## How to Get Started with the Model
+```python
+from transformers import pipeline
+model_id = "itsme-nishanth/Sparky-SQL-Llama-3.2-1B"
+pipe = pipeline("text-generation", model_id, device="cuda")
+messages = [
+    {"role": "user", "content": "list down the product names and its type provided by vendor 'vanhelsing' from 'products' table?"},
+]
+print(pipe(messages, max_new_tokens=100)[0]['generated_text'][-1])  # Print the assistant's response
+```
+<!-- Provide a longer summary of what this model is. -->
 
-Use the code below to get started with the model.
 
-[More Information Needed]
+- **Developed by:** Nishanth
+- **Model type:** Llama
+- **Language(s) (NLP):** English
+- **License:** Apache license 2.0
+- **Finetuned from model [optional]:** Llama-3.2-1B
 
 ## 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]
+- SQL Dataset [https://huggingface.co/shreeyashm/SQL-Queries-Dataset]
 
 ### Training Procedure
 
@@ -88,113 +55,35 @@ Use the code below to get started with the model.
 
 #### Preprocessing [optional]
 
-[More Information Needed]
+Dataset had empty records. Removed them before training.
 
 
 #### 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]
+- **Training regime:**
+- gradient_accumulation_steps = 4,
+- warmup_steps = 5,
+- max_steps = 60,
+- learning_rate = 2e-4,
+- fp16 = not is_bfloat16_supported(),
+- bf16 = is_bfloat16_supported(),
+- optim = "adamw_8bit",
+- weight_decay = 0.01,
+- lr_scheduler_type = "linear",
+- seed = 3407
 
-#### 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]
+- Google-Colab (Tesla T4)
 
 #### 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]
+- Transformers
+- Unsloth
 
 ## Model Card Contact
 
-[More Information Needed]
+[email protected]