Updated Readme.md

README.md

@@ -2,12 +2,20 @@
 library_name: transformers
 tags:
 - unsloth
+datasets:
+- Telugu-LLM-Labs/yahma_alpaca_cleaned_telugu_filtered_and_romanized
+- >-
+  Telugu-LLM-Labs/teknium_GPTeacher_general_instruct_telugu_filtered_and_romanized
+pipeline_tag: text-generation
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
+Gemma 2B Model Finetuned on two Telugu Instruct Datasets:
 
+1. Telugu-LLM-Labs/yahma_alpaca_cleaned_telugu_filtered_and_romanized
+2. Telugu-LLM-Labs/teknium_GPTeacher_general_instruct_telugu_filtered_and_romanized
 
 
 ## Model Details
@@ -18,49 +26,25 @@ tags:
 
 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:** Sai Teja Mummadi
+- **Language(s) (NLP):** English, Telugu (Original Script and Transliterated(Romanized))
+- **Finetuned from model:** google/gemma-2b
 
-### 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]
+Text Generation, Telugu Chatbot, Telugu Text Generation
 
 ### 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]
+Telugu Text Summarization, Further Finetuning on Telugu Datasets
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+Model is still under development, might need further finetuning on other datasets
 
 ### Recommendations
 
@@ -72,131 +56,100 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 
 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. -->
+```
+alpaca_prompt = """Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
 
-### Testing Data, Factors & Metrics
+### Instruction:
+{}
 
-#### Testing Data
+### Input:
+{}
 
-<!-- This should link to a Dataset Card if possible. -->
+### Response:
+{}"""
+```
+```
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-[More Information Needed]
+device = torch.device('cuda' if torch.cuda.is_available() else 'cpu')
 
-#### Factors
+model_name = "TeluguHouseCollective/Gemma-2B-Telugu_Instruct_Finetuned"
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+tokenizer = AutoTokenizer.from_pretrained(model_name, padding_side="right")
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.bfloat16).to(device)
+```
+```
+inputs = tokenizer(
+[
+    alpaca_prompt.format(
+        "fibonacci series rayadaniki python program ivvu", # instruction
+        "", # input
+        "", # output - leave this blank for generation!
+    )
+], return_tensors = "pt").to("cuda")
 
-[More Information Needed]
+outputs = model.generate(**inputs, max_new_tokens = 256, use_cache = True)
+tokenizer.batch_decode(outputs)
+```
 
-#### Metrics
+Model Output was as following:
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+```
+Response:\nfibonnaci rayadaniki python program ikkada vundi:\n\n\'\'\'\n
+def fibonacci(n):\n    """\n    fibonacci series rayadaniki python program.\n    """\n
+a = 0\n    b = 1\n    series = [a, b]\n
+for i in range(2, n + 1):\n
+series.append(a + b)\n
+a, b = b, a + b\n
+return series\n\n#
+fibonacci series rayadaniki 10 vibhinna sankhyalanu rayandi\n
+series = fibonacci(10)\nprint(series)\n\'\'\'\n\n
+e program fibonacci series rayadaniki python language upayogistamdi
+mariyu fibonacci(n) function upayoginchi fibonacci(n) sankhyanu
+rayadaniki fibonacci(n) function upayogistamdi.
+fibonacci(n) function yokka prarambha viluvanu 0 mariyu 1 set cheyadam dwara prarambhamavuthundi,
+mariyu idi fibonacci(n) yokka prarambha viluvanu 0 mariyu 1 nundi n nundi 1 nundi 0 varaku prarambhama
 
-[More Information Needed]
+```
 
-### Results
+Another input in telugu
 
-[More Information Needed]
 
-#### Summary
+```
+inputs = tokenizer(
+[
+    alpaca_prompt.format(
+        "ఆరోగ్యంగా ఉండాలి అంటే ఎం చేయాలి?", # instruction
+        "", # input
+        "", # output - leave this blank for generation!
+    )
+], return_tensors = "pt").to("cuda")
 
+outputs = model.generate(**inputs, max_new_tokens = 256, use_cache = True)
+tokenizer.batch_decode(outputs)
+```
 
 
-## Model Examination [optional]
+Model Output was as following:
 
-<!-- Relevant interpretability work for the model goes here -->
+```
+### Response:
+oka nirdishta anubhavanni batti, miru aaharam mariyu poshanalapai drishti pettavachu. kani, oka nirdishta anubhavanni batti, miru aaharam mariyu poshanalapai drishti pettavachu.
 
-[More Information Needed]
+meeru aaharam mariyu poshanalapai drishti pettavachchu,
+endukante idi mee aarogyanni meruguparachadamla sahayapaduthundi.
+meeru aaharam mariyu poshanalapai drishti pettavachchu, endukante idi mee sarirak srama,
+nidra mariyu manasika aarogyanni meruguparachadamla sahayapaduthundi.
 
-## Environmental Impact
+meeru aaharam mariyu poshanalapai drishti pettavachchu,
+endukante idi mee sarirak srama, nidra mariyu manasika aarogyanni meruguparachadamla sahayapaduthundi.
+meeru aaharam mariyu poshanalapai drishti pettavachchu, endukante idi mee sarirak srama,
+nidra mariyu manasika aarogyanni meruguparachad
 
-<!-- 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]
-
-
+Sai Teja Mummadi