Add README.md

README.md

@@ -1,4 +1,18 @@
+
 ---
+language:
+- hi
+license: cc-by-4.0
+multilinguality:
+- monolingual
+source_datasets:
+- NanoDBPedia
+task_categories:
+- text-retrieval
+task_ids:
+- document-retrieval
+tags:
+- text-retrieval
 dataset_info:
 - config_name: corpus
   features:
@@ -8,10 +22,6 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 5328552
-    num_examples: 6045
-  download_size: 2192891
-  dataset_size: 5328552
 - config_name: qrels
   features:
   - name: query-id
@@ -20,10 +30,6 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 60640
-    num_examples: 1158
-  download_size: 22712
-  dataset_size: 60640
 - config_name: queries
   features:
   - name: _id
@@ -32,10 +38,6 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 5203
-    num_examples: 50
-  download_size: 4064
-  dataset_size: 5203
 configs:
 - config_name: corpus
   data_files:
@@ -50,3 +52,45 @@ configs:
   - split: train
     path: queries/train-*
 ---
+
+# Bharat-NanoBEIR: Indian Language Information Retrieval Dataset
+
+## Overview
+This dataset is part of the Bharat-NanoBEIR collection, which provides information retrieval datasets for Indian languages. It is derived from the NanoBEIR project, which offers smaller versions of BEIR datasets containing 50 queries and up to 10K documents each.
+
+## Dataset Description
+This particular dataset is the Hindi version of the NanoDBPedia dataset, specifically adapted for information retrieval tasks. The translation and adaptation maintain the core structure of the original NanoBEIR while making it accessible for Hindi language processing.
+
+## Usage
+This dataset is designed for:
+- Information Retrieval (IR) system development in Hindi
+- Evaluation of multilingual search capabilities
+- Cross-lingual information retrieval research
+- Benchmarking Hindi language models for search tasks
+
+## Dataset Structure
+The dataset consists of three main components:
+1. **Corpus**: Collection of documents in Hindi
+2. **Queries**: Search queries in Hindi
+3. **QRels**: Relevance judgments connecting queries to relevant documents
+
+## Citation
+If you use this dataset, please cite:
+```
+@misc{bharat-nanobeir,
+  title={Bharat-NanoBEIR: Indian Language Information Retrieval Datasets},
+  year={2024},
+  url={https://huggingface.co/datasets/carlfeynman/Bharat_NanoDBPedia_hi}
+}
+```
+
+## Additional Information
+- **Language**: Hindi (hi)
+- **License**: CC-BY-4.0
+- **Original Dataset**: NanoBEIR
+- **Domain**: Information Retrieval
+
+
+## License
+This dataset is licensed under CC-BY-4.0. Please see the LICENSE file for details.
+