Update README.md

README.md

@@ -1,24 +1,32 @@
-* * *
-# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
-# Doc / guide: https://huggingface.co/docs/hub/model-cards
-## Model Card for AnkiGPT-small
-
+---
+license: mit
+datasets:
+- ai4bharat/indic-align
+language:
+- en
+metrics:
+- accuracy
+base_model:
+- microsoft/DialoGPT-small
+pipeline_tag: text-generation
+library_name: diffusers
+tags:
+- text-generation-inference
+---
 # Model Card for AnkiGPT-small
 
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
-
 ## Model Details
 
 ### Model Description
 
 - **Developed by:** [anktechsol.com](www.anktechsol.com)
-- **Shared by:** [More Information Needed - anktechsol]
+- **Shared by:** [anktechsol]
 - **Model type:** Causal Language Model
 - **Language(s) (NLP):** English, potentially aspects of Indian languages/Hinglish due to fine-tuning data.
 - **License:** (Specify the license of the fine-tuned model, often inherited from the base model or dataset. DialoGPT uses MIT license, check the dataset license.)
-- **Finetuned from model [optional]:** `microsoft/DialoGPT-small`
+- **Finetuned from model:** `microsoft/DialoGPT-small`
 
-### Model Sources [optional]
+### Model Sources
 
 - **Repository:** `https://huggingface.co/anktechsol/ankiGPT-small` (This will be the link after pushing to the hub)
 
@@ -43,20 +51,3 @@ Based on initial testing, the model may exhibit repetitive text generation, espe
 ### Recommendations
 
 Users should be aware of the model's limitations in generating coherent long text and potential biases. It is recommended to experiment with different generation parameters (`max_length`, `no_repeat_ngram_size`, sampling strategies) to improve output quality. For any critical applications, thorough testing and human review of generated content are essential.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model using the `transformers` library.
-
-  from transformers import pipeline
-  
-  # Replace "anktechsol/ankiGPT-small" with your actual model ID on the Hugging Face Hub
-  generator = pipeline("text-generation", model="anktechsol/ankiGPT-small")
-  
-  # A detailed prompt related to India
-  prompt = "Write a short story about a day in the life of a student in a bustling Indian city, describing their commute, interactions at school, and a cultural event they attend in the evening. Keep it in hinglish"
-  
-  # Generate text with a reasonable max_length to allow for a detailed story
-  generated_text = generator(prompt, max_length=300, num_return_sequences=1)
-  
-  print(generated_text[0]['generated_text'])