Update README.md

README.md

@@ -1,76 +1,81 @@
+---
+task_categories:
+- question-answering
+language:
+- pa
+size_categories:
+- 1K<n<10K
+tags:
+- Religion
+---
+
+# Gurugranth Sahib Darpan Dataset by Prof. Sahib Singh
+
+This dataset contains a structured representation of the **Gurugranth Sahib Darpan** by **Prof. Sahib Singh**, including translations, interpretations, and annotations of the Sikh holy scripture.
+
+# Credits
+The dataset is scraped from https://www.gurugranthdarpan.net/darpan.html.
+
 ---
-task_categories:
-- question-answering
-language:
-- pa
-size_categories:
-- n<1K
+
+## Dataset Details
+
+- **Language**: Punjabi (Gurmukhi) and English  
+- **Source**: Prof. Sahib Singh’s "Gurugranth Sahib Darpan"  
+- **Format**: JSON, CSV, or plain text  
+- **Purpose**: For natural language processing (NLP) research, multilingual analysis, and spiritual studies  
+
 ---
 
-# Gurugranth Sahib Darpan Dataset by Sahib Singh
+## Features
 
-This dataset contains a structured representation of the Gurugranth Sahib Darpan by Prof. Sahib Singh, a renowned Sikh scholar. It includes translations, interpretations, and annotations of the Sikh holy scripture, Sri Guru Granth Sahib Ji. The dataset is designed for use in natural language processing (NLP), machine learning research, and spiritual study.
+### Example Data
+```json
+{
+    "Ang": "1",
+    "url": "https://www.gurugranthdarpan.net/0001.html",
+    "Bani":"ੴ ਸਤਿ ਨਾਮੁ ਕਰਤਾ ਪੁਰਖੁ ਨਿਰਭਉ ਨਿਰਵੈਰੁਅਕਾਲ ਮੂਰਤਿ ਅਜੂਨੀ ਸੈਭੰ ਗੁਰ ਪ੍ਰਸਾਦਿ ॥",
+    "Arath": "ਪਦ ਅਰਥ: ੴ ਉੱਚਾਰਨ ਵੇਲੇ ਇਸ....",
+}
+```
+
+# Installation and Usage
+## Step 1: Install Required Libraries
+```bash
+pip install datasets
+```
+## Step 2: Load the Dataset
 
-# Dataset Details
-Language: Punjabi (Gurmukhi script) $BANI$ and Its meaning or explanation $ARATH$
-Source: Based on the works of Prof. Sahib Singh
-Format: PARQUET
-Size: 
-Purpose:
-Text understanding and sentiment analysis
-Scriptural studies and transliteration
-NLP applications like text summarization or chatbot training
-Features
-Schema
-Each record includes:
+```python
+from datasets import load_dataset
 
-Shabad ID: Unique identifier for each verse or hymn.
-Scripture Text (Gurmukhi/ BANI): Original text from the Guru Granth Sahib.
-Translation (Punjabi/ARATH): Explanation in Punjabi language.
+ds = load_dataset("singhjagpreet/Gurbani_darpan", split="train")
 
+# Access the first record
+data = ds.with_format("np", columns=["Bani", "Arath"], output_all_columns=False)
+
+```
 
 # Applications
 This dataset can be used for:
 
-Religious and cultural studies: To understand Sikhism's core philosophy.
-NLP research: Develop translation models, sentiment analysis tools, or scriptural Q&A systems.
-Multilingual models: Train systems to handle Punjabi and English text together.
-Chatbots: Build AI systems capable of answering spiritual or scriptural queries.
+1. Building multilingual NLP models.
+2. Transliteration and translation systems.
+3. Scriptural Q&A and chatbot systems.
+3. Sentiment and context analysis.
 
-# How to Use
-Install the Hugging Face library:
-bash
-Copy code
-pip install datasets
-Load the dataset:
-python
-Copy code
-from datasets import load_dataset
+# Contributing
+Feel free to contribute! Submit pull requests or create issues to improve the dataset.
 
-dataset = load_dataset("singhjagpreet/Gurbani_darpan")
-Access the data:
-python
-Copy code
-print(dataset['train'][0])
-Licensing
-License: Specify the license (e.g., MIT, CC BY-NC-SA 4.0) to ensure proper usage and credit.
-Attribution: Credit Prof. Sahib Singh and the original scripture source.
-Acknowledgments
-Original Work: Prof. Sahib Singh's "Gurugranth Sahib Darpan."
-Community: Sikh researchers and scholars who made this dataset possible.
-Contributing
-Contributions are welcome! If you have corrections, suggestions, or additional annotations, feel free to open a pull request or create an issue on GitHub.
-
-Citation
+# Citation
 If you use this dataset in your research, please cite:
 
-bibtex
-Copy code
-@dataset{gurugranth_sahib_darpan,
+```bibtex
+@dataset{singhjagpreet/Gurbani_darpan,
   author = {Sahib Singh},
   title = {Gurugranth Sahib Darpan Dataset},
   year = {2024},
   publisher = {Hugging Face},
-  url = {https://huggingface.co/datasets/username/gurugranth_sahib_darpan}
+  url = {https://huggingface.co/datasets/singhjagpreet/Gurbani_darpan}
 }
-Feel free to modify this template to better suit the dataset's specific characteristics and requirements.
+```