Add README.md

README.md

@@ -1,4 +1,18 @@
+
 ---
+language:
+- gu
+license: cc-by-4.0
+multilinguality:
+- monolingual
+source_datasets:
+- NanoNFCorpus
+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: 11092013
-    num_examples: 2953
-  download_size: 4084392
-  dataset_size: 11092013
 - config_name: qrels
   features:
   - name: query-id
@@ -20,10 +30,6 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 64851
-    num_examples: 2518
-  download_size: 15828
-  dataset_size: 64851
 - config_name: queries
   features:
   - name: _id
@@ -32,10 +38,6 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 3710
-    num_examples: 50
-  download_size: 3404
-  dataset_size: 3710
 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 Gujarati version of the NanoNFCorpus dataset, specifically adapted for information retrieval tasks. The translation and adaptation maintain the core structure of the original NanoBEIR while making it accessible for Gujarati language processing.
+
+## Usage
+This dataset is designed for:
+- Information Retrieval (IR) system development in Gujarati
+- Evaluation of multilingual search capabilities
+- Cross-lingual information retrieval research
+- Benchmarking Gujarati language models for search tasks
+
+## Dataset Structure
+The dataset consists of three main components:
+1. **Corpus**: Collection of documents in Gujarati
+2. **Queries**: Search queries in Gujarati
+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_NanoNFCorpus_gu}
+}
+```
+
+## Additional Information
+- **Language**: Gujarati (gu)
+- **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.
+