Update README.md

README.md

@@ -1,43 +1,42 @@
----
-license: mit
-task_categories:
-- question-answering
-- text-classification
-- text-generation
----
-# Hindi Web Content Dataset
-## Overview
+**Hindi Web Content Dataset**
+===========================
+### Overview
 This dataset contains a collection of Hindi text data scraped from various websites. The data was collected using a domain-restricted scraper that extracts paragraphs of text from specified domains. The dataset includes content from news articles, literature, and other web pages. The scraped text has been stored in JSON format and is intended for use in natural language processing (NLP) tasks, such as language modeling, text generation, and sentiment analysis.
-## Dataset Details
-* Size: At least 30MB of text data
-* Language: Hindi
-* Format: JSON
-* Source Domains:
+### License
+* **MIT**
+### Task Categories
+* **Question-Answering**
+* **Text-Classification**
+* **Text-Generation**
+### Dataset Details
+* **Size**: At least 30MB of text data
+* **Language**: Hindi
+* **Format**: JSON
+* **Source Domains**:
 + [NDTV Hindi](https://ndtv.in)
 + [Jansatta](https://www.jansatta.com)
 + [Hindwi](https://www.hindwi.org)
-## Structure of the Dataset
-The dataset is stored in a JSON file named scraped_data.json. Each entry in the JSON file corresponds to a web page and contains the following fields:
-* url: The URL of the web page.
-* title: The title of the web page.
-* paragraphs: A list of paragraphs extracted from the web page.
-### Example Entry
-
+### Structure of the Dataset
+The dataset is stored in a JSON file named `scraped_data.json`. Each entry in the JSON file corresponds to a web page and contains the following fields:
+* **url**: The URL of the web page.
+* **title**: The title of the web page.
+* **paragraphs**: A list of paragraphs extracted from the web page.
+#### Example Entry
 ```json
 {
-    "url": "https://example.com/article",
-    "title": "Example Article Title",
-    "paragraphs": [
-        "This is the first paragraph of the article.",
-        "This is the second paragraph of the article.",
-        // More paragraphs...
-    ]
+"url": "https://example.com/article",
+"title": "Example Article Title",
+"paragraphs": [
+"This is the first paragraph of the article.",
+"This is the second paragraph of the article.",
+// More paragraphs...
+]
 }
 ```
-}
-## How to Use Load the Dataset
-You can load the JSON file using standard Python libraries such as json or use data processing libraries like pandas.
-```
+### How to Use
+#### Load the Dataset
+You can load the JSON file using standard Python libraries such as `json` or use data processing libraries like `pandas`.
+```python
 import json
 with open('scraped_data.json', 'r', encoding='utf-8') as file:
 data = json.load(file)
@@ -50,15 +49,17 @@ for paragraph in paragraphs:
 all_paragraphs.append(paragraph)
 # Now all_paragraphs contains all the paragraphs concatenated
 ```
-Loading the Dataset with Hugging Face
-You can also load this dataset directly using the Hugging Face datasets library. The dataset is available under the identifier Threatthriver/Hindi-story-news.
-Example Code
+#### Loading the Dataset with Hugging Face
+You can also load this dataset directly using the Hugging Face datasets library. The dataset is available under the identifier `Threatthriver/Hindi-story-news`.
+Example Code:
+```python
 from datasets import load_dataset
 ds = load_dataset("Threatthriver/Hindi-story-news")
-This will load the dataset into a datasets.Dataset object, which you can then use for various NLP tasks.
-License
+# This will load the dataset into a datasets.Dataset object, which you can then use for various NLP tasks.
+```
+### License
 The data scraped from the mentioned websites is subject to their respective terms of use and copyright policies. Users of this dataset must ensure that their use complies with these terms and respects the intellectual property rights of the content owners.
-Acknowledgements
+### Acknowledgements
 We acknowledge the efforts of the content creators and website owners for providing valuable information in the Hindi language. Their contributions are invaluable for advancing NLP research and applications in regional languages.
-Contact
+### Contact
 For any questions or issues regarding this dataset, please feel free to reach out to us.