Update README.md

README.md

@@ -1,19 +1,29 @@
-# Fine-Tuned Falcon 7B - Indian Law 
-
-This is a Falcon 7B model, fine-tuned on a dataset pertaining to Indian law.
+---
+language: 
+  - en
+Tags:
+- fine-tuned
+- legal
+- Indian law
+license: "apache-2.0"
+metrics:
+- perplexity
+---
+
+# Fine-Tuned Falcon 7B - Indian Law
+
+This is a Falcon 7B model fine-tuned for question answering in the domain of Indian law. It has been trained to answer questions regarding various aspects of the Indian legal system, such as the Constitution, the roles of governmental positions, and more. 
 
 ## Model Description
 
-Falcon is a family of state-of-the-art language models created by the Technology Innovation Institute in Abu Dhabi. The Falcon 7B model was fine-tuned on a dataset specifically curated with questions and answers about Indian law. The questions cover a wide range of legal topics, from the components of the Indian Constitution to the roles of various governmental positions.
-
-## Fine-tuning details
-
-The model was trained using a batch size of 1 and a learning rate of 2e-4 over five epochs. The maximum sequence length was set to 512 tokens, and gradient accumulation was used with a step size of four. The model was trained for a total of 250 steps.
+Falcon is a family of state-of-the-art language models created by the Technology Innovation Institute in Abu Dhabi. This version, Falcon 7B, has been fine-tuned to specialize in understanding and generating responses related to Indian law. The model was trained on a custom dataset composed of question-answer pairs about Indian law.
 
-## Intended uses
+## How to use
 
-This model is intended to be used for answering questions related to Indian law. This could include use cases such as legal advice platforms, legal research tools, or educational applications.
+You can use this model for generating responses. Here is how to do it:
 
-## Limitations
+```python
+from transformers import pipeline
 
-While the model has been trained specifically on a dataset about Indian law, it's important to remember that it doesn't have a comprehensive understanding of the legal system or context. The model's responses should be used as a starting point for legal research, not as a definitive legal advice.
+generator = pipeline('text-generation', model='path_to_your_model')
+print(generator("<human>: What is the role of the Judiciary as per the Constitution of India?", max_length=100))