Update README.md

README.md

@@ -14,4 +14,83 @@ language_creators:
 multilinguality:
   - monolingual
 pretty_name: Thirukkural_QA
----
+---
+
+# Summary
+`thirukkural_QA` is an open source dataset of instruct-style records generated by converting publicly available data on Thirukkural and it's meaning.
+This was created as part of [Aya Open Science Initiative](https://sites.google.com/cohere.com/aya-en/home) by Cohere For AI.
+
+This dataset can be used for any purpose, whether academic or commercial, under the terms of the [Apache 2.0](https://opensource.org/license/apache-2-0) License.
+
+Supported Tasks:
+- Training LLMs
+- Synthetic Data Generation
+- Data Augmentation
+- Question Answering
+
+Languages: Tamil Version: 1.0
+
+# Dataset Overview
+`thirukkural_QA` is a corpus of 3990 records generated by converting existing Thirukkural and its meaning into instruction-style. This Dataset can be used for the following tasks:
+- Given the thirukkural and ask for its meaning, generates the meaning of the kural.
+- Given the meaning of the kural, generates the original kural.
+- Given the beginning of a kural, generates the original kural.
+
+# Intended Uses
+While immediately valuable for instruction fine tuning large language models, as a corpus of instruction prompts, this dataset also presents a valuable opportunity for synthetic data generation. For example, prompt-completions could be submitted as few-shot examples to a large open language model to generate new kurals in a similar style.
+
+# Dataset
+
+## Load with Datasets
+To load this dataset with Datasets, you'll just need to install Datasets as `pip install datasets --upgrade` and then use the following code:
+
+```python
+from datasets import load_dataset
+ds = load_dataset('aitamilnadu/thirukkural_QA')
+```
+
+## Purpose of Collection
+Tamil is a low-resource language (inspite of having rich literature) where there are no instruct-style dataset to the best of my knowledge. 
+This was created as a part of [Aya Open Science Initiative](https://sites.google.com/cohere.com/aya-en/home) from Cohere For AI to make sure Tamil is well represented in the space of AI/ML. 
+Unlike other datasets that are limited to non-commercial use, this dataset can be used, modified, and extended for any purpose, including academic or commercial applications.
+
+## Sources
+- **[Thirukkural.com](http://www.thirukkural.com/)**: The data from this website is scraped and available at [Thirukkural-Tamil-Dataset](https://github.com/vijayanandrp/Thirukkural-Tamil-Dataset).
+- The scraped data is carefully analysed making sure there are no missed words, spelling mistakes and the data is in Tamil only.
+- Next, some pre-processing is performed to extract kural, adhigaram, kural no and different meanings seperately from the scraped data.
+- Finally, converted the scraped data into instruct-style prompts and completions.
+
+
+## Templates
+For the creation of instruct-style prompts and completions from the scraped data, the following one template was used:
+1. Given the name of the food item, generates the detailed recipe along with the ingredients.
+```python
+Prompt:
+("{{Food Item}} ఎలా తయారు చేస్తారో క్లుప్తంగా ఇవ్వండి." /
+"మీరు {{Food Item}} తయారు చెయ్యడానికి ఎటువంటి తిండి పదార్ధాలు వాడుతురు మరియు ఏ విధముగా చేస్తారో వివరణ ఇవ్వండి." / 
+"నేను {{Food Item}} చాలా రుచికరంగా ఉంటుంది అని విన్నాను. నాకు ఇది ఎలా చెయ్యాలో సంక్లిప్తంగా చెప్పు." /
+"మొదటిసారి వంట చేసేవారికి చెప్పినట్టు నాకు {{Food Item}} ఎలా చెయ్యాలొ చెప్పు" /
+"{{Food Item}} ఎలా చేయాలి? సమాధానం లో కావలసిన పదార్ధాలు మరియు తయారు చేసే విధానం ఉండాలి." /
+"{{Food Item}} ఎలా తయారు చేస్తాం?" /
+"{{Food Item}} రెసిపీ ఏంటి?")
+
+Completion:
+{{Food Item}} కి కావలసిన పదార్ధాలు మరియు తయారు చేసే విధానం ఇక్కడ ఇవ్వబడింది.
+కావలసిన పదార్థాలు:
+{{Ingredients}}
+
+తయారుచేసే విధానం:
+{{Cooking Instructions}}
+```
+
+## Personal or Sensitive Data
+This dataset contains public information. To my knowledge, there are no private person’s personal identifiers or sensitive information.
+
+## Language
+Tamil
+
+# Known Limitations
+- The meanings used in the prompts/completions are chosen randomly based on the availability of complete sentences and this may reflect some bias by ignoring other meanings written by other scholars.
+
+# Contributors
+[AbinayaM02](https://github.com/AbinayaM02)