updates

README.md

@@ -1,77 +1,55 @@
 ---
 library_name: transformers
-tags: []
+license: llama3
+datasets:
+- smallstepai/marathi-instruction-tuning-alpaca
+- ai4bharat/indic-align
+language:
+- mr
+- en
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+<!--  -->
 
 
 
 ## Model Details
+Shivneri Marathi LLM is being built with the wish to bring the benefits of Generative AI to non-English (especially Marathi) speaking population of India.
+Marathi has the third largest number of native speakers in India, after Hindi and Bengali. 
+Almost 83 million people speak the language. 
+This is a  preliminary version of our Marathi LLM (Large Language Model)!
+Built on the mighty Gemma 7B base model, Shivneri LLM can generate creative and informative text in both Marathi and English.  This is just the beginning – we're constantly improving Shivneri, and even more exciting features are on the horizon!
+
 
 ### 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]
+- **Developed by:** Amit Ghadge
 - **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Shared by [optional]:** [Amit Ghadge]
+- **Model type:** [ Decoder-only large language model (LLM) with a transformer architecture]
+- **Language(s) (NLP):** [Marathi, English]
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model [optional]:** [Meta-Llama-3-8B-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]
+- **Repository:** [https://github.com/amitagh/shivneri-llm]
+- **Paper [optional]:** [https://medium.com/@amitagh/shivneri-marathi-llm-e823f0a045d8]
+- **Demo [optional]:** [Coming soon]
 
 ## 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. -->
+This is a very preliminary version. Please use with caution. Would suggest to more updates and final models to try out.
 
-### 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.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
 
 ## Training Details
 
@@ -79,121 +57,53 @@ Use the code below to get started with the model.
 
 <!-- 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]
+[SFT with Lora on mentioned datasets above]
 
 ### Training Procedure
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+SFT with Lora
 
-#### 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]
+[ Decoder-only large language model (LLM) with a transformer architecture]
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
+[A100 80 GB]
 
-#### Software
+## Meet the Developers
 
-[More Information Needed]
+Get to know the creators behind this innovative model and follow their contributions to the field:
 
-## 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]
+- [Amit Ghadge](https://www.linkedin.com/in/amit-ghadge-a162a115/)
 
-**APA:**
+## Model Release Date May 1st, 2024.
 
-[More Information Needed]
+Status This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we improve model safety with community feedback.
 
-## Glossary [optional]
+## License
+The model inherits the license from meta-llama3.
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## How to use 
+Use pretty much remains the same as original Meta-Llama-3-8B-Instruct model. Visit its page for more details.
+With this model you can now use Marathi prompts and build conversational apps using it.
 
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
+## Citation [optional]
 
-## Model Card Authors [optional]
+If you use this model in your research, please cite:
 
-[More Information Needed]
+```bibtex
+@misc{amitghadge2024ShivneriLLMv01,
+      title={Shivneri-LLM: Your Bilingual Marathi and English Text Generation LLM}, 
+      author={Amit Ghadge},
+      year={2024},
+      eprint={https://medium.com/@amitagh/shivneri-marathi-llm-e823f0a045d8},
 
-## Model Card Contact
+}
+```
 
-[More Information Needed]
+We hope this model serves as a valuable tool in your NLP toolkit and look forward to seeing the advancements it will enable in the understanding and generation of the Marathi language.