Update README.md

README.md

@@ -1,3 +1,98 @@
 ---
-license: apache-2.0
+annotations_creators:
+- expert-generated
+language:
+- te
+language_creators:
+- expert-generated
+license:
+- apache-2.0
+multilinguality:
+- monolingual
+pretty_name: Telugu Jokes
+size_categories:
+- n<1K
+source_datasets:
+- original
+tags:
+- food
+- recipes
+task_categories:
+- text-generation
+task_ids:
+- language-modeling
 ---
+
+# Summary
+`aya-telugu-jokes` is an open source dataset of instruct-style records generated by webscraping a Telugu Jokes website. This was created as part of [Aya Open Science Initiative](https://sites.google.com/cohere.com/aya-en/home) from 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
+
+Languages: Telugu Version: 1.0
+
+# Dataset Overview
+`aya-telugu-jokes` is a corpus of more than 900 records generated by webscraping of the Telugu Jokes website. This Dataset can be used for the following task:
+- Given the title of a funny conversation, generate a funny conversation based on the title.
+
+# 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 in the methods. For example, prompt-completions could be submitted as few-shot examples to a large open language model to generate additional funny conversations and their titles.
+
+# 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('SuryaKrishna02/aya-telugu-jokes')
+```
+
+## Purpose of Collection
+Telugu is a low-resource language where there no funny conversation generation 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 Telugu 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
+- **Andhrajyothi Website**: Performed webscraping from [Andhrajyothi Website](https://lit.andhrajyothy.com/jokes/) which is a website consisting of funny conversations. Next, performed some pre-processing of the data like removing unwanted characters 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 title of a funny conversation, generate a funny conversation based on the title.
+```python
+Prompt:
+("{{Title}} అనే శీర్షిక తో జోక్ ఇవ్వు" /
+"{{Title}} అనే టైటిల్ తో జోక్ ఇవ్వు" /
+"ఒక హాస్య సంభాషణ ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న హాస్య సన్నివేశం ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చమత్కారమయిన  సంభాషణ ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న చమత్కారమయిన  సన్నివేశం ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు. " /
+"ఒక తమాషా అయినా సంభాషణ ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న తమాషా అయినా సన్నివేశం ఇవ్వు మరియు దాని యొక్క శీర్షిక {{Title}} ఉండే లాగా ఇవ్వు. " /
+"ఒక హాస్య సంభాషణ ఇవ్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న హాస్య సన్నివేశం ఇవ్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చమత్కారమయిన  సంభాషణ ఇవ్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న చమత్కారమయిన  సన్నివేశం ఇ���్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక తమాషా అయినా సంభాషణ ఇవ్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు." /
+"ఒక చిన్న తమాషా అయినా సన్నివేశం ఇవ్వు మరియు దాని యొక్క టైటిల్ {{Title}} ఉండే లాగా ఇవ్వు.")
+
+Completion:
+శీర్షిక: {{Title}}
+
+{{Funny Conversation}}
+```
+
+## Personal or Sensitive Data
+This dataset contains public information. To our knowledge, there are no private person’s personal identifiers or sensitive information.
+
+## Language
+Telugu
+
+# Known Limitations
+- The Dataset is scraped from the Jokes Website and the contents of this dataset may reflect the bias, factual errors, inappropriate and sensitive matters.
+- Although there is utmost care taken to keep the dataset as monolingual, there might be some records that may contain English Language along with Telugu.
+
+# Contributors
+[SuryaKrishna02](https://github.com/SuryaKrishna02) and [Desik98](https://github.com/desik1998)