Update README.md

README.md

@@ -1,3 +1,92 @@
----
-license: mit
----
+---
+license: mit
+task_categories:
+- text-classification
+language:
+- hi
+- ur
+tags:
+- urdu
+- hindi
+- urdu translitration
+pretty_name: Urdu-Hindi Data
+size_categories:
+- 1K<n<10K
+---
+# Hindi Transliteration of Urdu Poetry Dataset
+
+Welcome to the **Hindi Transliteration of Urdu Poetry Dataset**! This dataset features Hindi transliterations of traditional Urdu poetry. Each entry in the dataset includes two columns:
+- **Title:** The transliterated title of the poem in Hindi.
+- **Poem:** The transliterated text of the Urdu poem rendered in Hindi script.
+
+This dataset is perfect for researchers and developers working on cross-script language processing, transliteration models, and comparative literary studies.
+
+---
+
+## Dataset Overview
+
+This dataset offers a rich collection of Urdu poetry, transliterated into Hindi. By providing both the title and the complete poem in Hindi script, it aims to bridge the gap between Urdu literature and Hindi readers. The dataset is structured in a tabular format, making it easy to work with using popular data processing tools.
+
+Each record contains:
+- **Poem Title:** The title of the poem, transliterated into Hindi.
+- **Poem Text:** The full poem text, transliterated into Hindi.
+
+---
+
+## Data Format
+
+The dataset is available in standard tabular formats such as CSV or JSON. Each entry includes the following columns:
+
+- **title** (`string`): The transliterated title of the poem.
+- **poem** (`string`): The transliterated full text of the poem.
+
+*Example (CSV format):*
+```csv
+title,poem
+"दिल की किताब","यह इश्क़ नहीं आसान, बस इतना समझ लीजिये..."
+"फूलों का सिलसिला","खुशबुओं की महफ़िल में, एक फूल कहानी कहता है..."
+How to Load the Dataset
+You can easily load the dataset using the Hugging Face Datasets library. Below is an example in Python:
+
+python
+Copy
+Edit
+from datasets import load_dataset
+
+# Replace 'your-username/hindi-transliteration-urdu-poetry' with the actual repository name on Hugging Face Hub
+dataset = load_dataset("your-username/hindi-transliteration-urdu-poetry")
+
+# Accessing the train split (if applicable, otherwise adjust accordingly)
+print(dataset['train'][0])
+Note: Ensure that you have the datasets library installed:
+
+bash
+Copy
+Edit
+pip install datasets
+Intended Use Cases
+Transliteration Research: Develop and evaluate models for transliterating text between scripts.
+Cross-Lingual Studies: Analyze similarities and differences in poetic expression across languages.
+Text Generation: Train language models for generating poetry in Hindi using transliterated content.
+Cultural and Literary Studies: Explore themes, styles, and cultural narratives in Urdu poetry made accessible to Hindi readers.
+License
+This dataset is distributed under the MIT License. See the LICENSE file for more details.
+
+Contributing
+Contributions to the dataset are welcome! If you have improvements, additional data, or suggestions, please open an issue or submit a pull request on the GitHub repository.
+
+Citation
+If you find this dataset useful in your work, please consider citing it. For example:
+
+bibtex
+Copy
+Edit
+@dataset{yourusername2025hinditranslit,
+  author       = {Your Name},
+  title        = {Hindi Transliteration of Urdu Poetry Dataset},
+  year         = {2025},
+  publisher    = {Hugging Face},
+  url          = {https://huggingface.co/datasets/your-username/hindi-transliteration-urdu-poetry},
+}
+Contact
+For any questions, suggestions, or issues, please contact [email protected]