updated readme

README.md

@@ -1,3 +1,119 @@
 ---
-license: cc-by-sa-4.0
+annotations_creators:
+- expert-generated
+language:
+- hi
+language_creators:
+- expert-generated
+license:
+- cc-by-sa-4.0
+multilinguality:
+- monolingual
+pretty_name: Hindi Article Summarization
+size_categories:
+- n>1K
+source_datasets:
+- extended|https://www.kaggle.com/datasets/disisbig/hindi-text-short-summarization-corpus
+tags:
+- generation
+task_categories:
+- text-generation
+task_ids:
+- language-modeling
 ---
+
+# Summary
+`hindi-article-summarization` is an open source dataset of instruct-style records generated from the [Hindi Text Short and Large Summarization](https://www.kaggle.com/datasets/disisbig/hindi-text-short-and-large-summarization-corpus) dataset. 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 [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) License.
+
+Supported Tasks:
+- Training LLMs
+- Synthetic Data Generation
+- Data Augmentation
+
+Languages: Hindi Version: 1.0
+
+# Dataset Overview
+`hindi-article-summarization` is a corpus of  records generated by conversion of [Hindi Text Short and Large Summarization](https://www.kaggle.com/datasets/disisbig/hindi-text-short-and-large-summarization-corpus) dataset into Instruct-Style format. This Dataset can be used for the following task:
+- Given an article, generate its summary.
+
+# 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 sentence and corresponding paraphrased sentence. 
+
+# 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('ganeshjcs/hindi-article-summarization')
+```
+
+## Purpose of Collection
+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 Hindi is well represented in the space of AI/ML. This dataset can be used, modified, and extended for any purpose, including academic or commercial applications.
+
+## Sources
+- **[Hindi Text Short and Large Summarization Corpus](https://www.kaggle.com/datasets/disisbig/hindi-text-short-and-large-summarization-corpus)**: Converted this dataset into Instruct-style prompts and completions.
+
+## Data Fields
+- `inputs`       : Prompt or input to the language model.
+- `targets`      : Completion or output of the language model.
+- `template_id`  : Id of the template used in `inputs` and `targets`.
+- `template_lang`: ISO code of the language used in the `inputs` and `targets` where *tel* refers to Telugu.
+
+## Templates
+For the creation of instruct-style prompts and completions from the original dataset, the following one template category with 6 different variations were used:
+1. Given a sentence, generate a sentence with similar meaning.
+
+   | template_id | inputs | targets |
+   |-------------|--------|---------|
+   | 0 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```संक्षिप्त सारांश: {{Summary}}``` |
+   | 1 | ```इस के लिए एक सारांश बनाएं: {Article}}``` | ```यह एक सारांश है: {{Summary}}``` |
+   | 2 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```संक्षिप्त पाठ: {{Summary}}``` |
+   | 3 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```{{Summary}}``` |
+   | 4 | ```एक सारांश बनाओ: {{Article}}``` | ```{{Summary}}``` |
+   | 5 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```सारांश: {{Summary}}``` |
+   | 6 | ```एक सारांश बनाओ: {{Article}}``` | ```यहाँ एक सारांश है: {{Summary}}``` |
+   | 7 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```संक्षिप्त सारांश: {{Summary}}``` |
+   | 8 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```दिए गए पाठ का सारांश यह हो सकता है: {{Summary}}``` |
+   | 9 | ```एक सारांश बनाओ: {{Article}}``` | ```सारांश: {{Summary}}``` |
+   | 10 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```संक्षिप्त सारांश: {{Summary}}``` |
+   | 11 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```यहाँ एक सारांश है: {{Summary}}``` |
+   | 12 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```सारांश: {{Summary}}``` |
+   | 13 | ```एक सारांश बनाओ: {{Article}}``` | ```यह एक सारांश है: {{Summary}}``` |
+   | 14 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```संक्षिप्त पाठ: {{Summary}}``` |
+   | 15 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```यहाँ एक सारांश है: {{Summary}}``` |
+   | 16 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```सारांश: {{Summary}}``` |
+   | 17 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```संक्षिप्त पाठ: {{Summary}}``` |
+   | 18 | ```एक सारांश बनाओ: {{Article}}``` | ```संक्षिप्त सारांश: {{Summary}}``` |
+   | 19 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```दिए गए पाठ का सारांश यह हो सकता है: {{Summary}}``` |
+   | 20 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```{{Summary}}``` |
+   | 21 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```संक्षिप्त पाठ: {{Summary}}``` |
+   | 22 | ```एक सारांश बनाओ: {{Article}}``` | ```दिए गए पाठ का सारांश यह हो सकता है: {{Summary}}``` |
+   | 23 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```यह एक सारांश है: {{Summary}}``` |
+   | 24 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```{{Summary}}``` |
+   | 25 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```{{Summary}}``` |
+   | 26 | ```इस पाठ का सारांश बनाओ: {{Article}}``` | ```यह एक सारांश है: {{Summary}}``` |
+   | 27 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```दिए गए पाठ का सारांश यह हो सकता है: {{Summary}}``` |
+   | 28 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```यह एक सारांश है: {{Summary}}``` |
+   | 29 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```संक्षिप्त सारांश: {{Summary}}``` |
+   | 30 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```सारांश: {{Summary}}``` |
+   | 31 | ```इस पाठ का सारांश बनाएं: {{Article}}``` | ```यहाँ एक सारांश है: {{Summary}}``` |
+   | 32 | ```इस के लिए एक सारांश बनाएं: {{Article}}``` | ```दिए गए पाठ का सारांश यह हो सकता है: {{Summary}}``` |
+   | 33 | ```एक सारांश बनाओ: {{Article}}``` | ```संक्षिप्त पाठ: {{Summary}}``` |
+   | 33 | ```दिए गए पाठ के लिए एक सारांश बनाएं: {{Article}}``` | ```यहाँ एक सारांश है: {{Summary}}``` |
+
+## Personal or Sensitive Data
+This dataset contains public information. To our knowledge, there are no private person’s personal identifiers or sensitive information.
+
+## Language
+Hindi
+
+# Known Limitations
+- The Dataset is converted from the existing dataset and the contents of this dataset may reflect the bias, factual errors 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 Hindi.
+
+# Contributors
+[Ganesh Jagadeesan](https://github.com/ElefHead)