Update README.md

README.md

@@ -1,3 +1,16 @@
+---
+language: en
+tags:
+- text-generation
+- YouTube-scripts
+- fine-tuned
+- causal-lm
+datasets:
+- custom
+license: mit
+model_name: Gemma 2 Scripter
+---
+
 # Gemma 2 Scripter
 
 **Gemma 2 Scripter** is a fine-tuned version of the Gemma 2 2B instruct model designed for generating high-quality YouTube scripts based on provided keywords. It is optimized for text generation tasks, delivering coherent and contextually relevant outputs.
@@ -96,6 +109,41 @@ The output is a YouTube script generated based on the keywords provided.
 - Generating structured scripts for video content
 - Keyword-based text generation for creative tasks
 
+## Training Details
+
+### Training Data
+
+The model was fine-tuned on a custom dataset of YouTube scripts paired with their corresponding keywords.
+
+### Training Procedure
+
+- **Fine-tuning Method**: LoRA (Low-Rank Adaptation)
+- **Optimization**: AdamW optimizer
+- **Learning Rate**: 2e-4
+- **Batch Size**: 4
+- **Training Steps**: 1000
+
+## Limitations
+
+- The model's output quality depends on the clarity and relevance of input keywords
+- May occasionally generate repetitive content
+- Performance may vary based on hardware capabilities
+
+## Citation
+
+If you use this model in your research, please cite:
+
+```bibtex
+@misc{gemma2_scripter,
+  author = {Sidharthan},
+  title = {Gemma 2 Scripter: Fine-tuned YouTube Script Generator},
+  year = {2024},
+  publisher = {Hugging Face},
+  journal = {Hugging Face Model Hub},
+  howpublished = {\url{https://huggingface.co/Sidharthan/gemma2_scripter}}
+}
+```
+
 ### License
 
 This model is released under the MIT License.