Update README.md

README.md

@@ -1,26 +1,119 @@
----
-dataset_info:
-  config_name: hi
-  features:
-  - name: Article Title
-    dtype: string
-  - name: Entity Name
-    dtype: string
-  - name: Wikidata ID
-    dtype: string
-  - name: English Wikipedia Title
-    dtype: string
-  - name: Image Name
-    dtype: image
-  splits:
-  - name: train
-    num_bytes: 1233713455.476
-    num_examples: 1414
-  download_size: 336952362
-  dataset_size: 1233713455.476
-configs:
-- config_name: hi
-  data_files:
-  - split: train
-    path: hi/train-*
----
+
+# MERLIN Dataset
+
+## Dataset Description
+
+### Overview
+MERLIN (Multilingual Entity Recognition and Linking) is a test dataset for evaluating multilingual entity linking systems with multimodal inputs. The dataset contains news articles in multiple languages along with associated images and entity annotations.
+
+### Supported Tasks
+- Multimodal Entity Linking
+- Cross-lingual Entity Linking
+- Named Entity Recognition
+
+### Languages
+- Hindi
+- [Add other languages present in your dataset]
+
+### Data Instances
+Each instance in the dataset contains:
+```python
+{
+    "Article Title": "बिहार: केंद्रीय मंत्री अश्विनी चौबे के बेटे अर्जित 'गिरफ्तार'",  # Article title in original language
+    "Entity Name": "अश्विनी चौबे",                # Entity mention in original language
+    "Wikidata ID": "Q16728021",                   # Unique Wikidata identifier
+    "English Wikipedia Title": "Ashwini Kumar Choubey",  # Corresponding English Wikipedia title
+    "Image Name": "<GCS_URL>"                     # URL to associated image
+}
+```
+
+### Data Fields
+- `Article_Title`: The title of the news article in its original language
+- `Entity_Name`: The name of the entity to be linked in its original language
+- `Wikidata_ID`: The corresponding Wikidata identifier for the entity
+- `English_Wikipedia_Title`: The English Wikipedia page title for the entity
+- `image`: Associated image URL from Google Cloud Storage
+
+### Data Splits
+The dataset contains only a test split with [number] examples.
+
+## Dataset Creation
+
+### Source Data
+[Describe where the data comes from, e.g., news sources, etc.]
+
+### Annotations
+[Describe how entities were annotated/linked]
+
+## Dataset Structure
+
+### Data Instances
+Example of a data instance:
+```python
+{
+    "Article_Title": "बिहार: केंद्रीय मंत्री अश्विनी चौबे के बेटे अर्जित 'गिरफ्तार'",
+    "Entity_Name": "अश्विनी चौबे",
+    "Wikidata_ID": "Q16728021",
+    "English_Wikipedia_Title": "Ashwini Kumar Choubey",
+    "Image_Name": "<GCS_URL>"
+}
+```
+
+### Data Fields
+- `Article_Title`: string
+- `Entity_Name`: string
+- `Wikidata_ID`: string
+- `English_Wikipedia_Title`: string
+- `image`: binary image data
+
+### Data Statistics
+- Total number of instances: [number]
+- Number of unique entities: [number]
+- Languages covered: [list of languages]
+- [Any other relevant statistics]
+
+## Dataset Creation
+
+### Curation Rationale
+[Explain why this dataset was created]
+
+### Source Data
+[Describe the source of the articles and images]
+
+### Annotations
+[Describe the annotation process if any]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+[Describe potential social impacts]
+
+### Discussion of Biases
+[Discuss any potential biases in the data]
+
+### Other Known Limitations
+[Describe any known limitations]
+
+## Additional Information
+
+### Dataset Curators
+[Your name/organization]
+
+### Licensing Information
+[License information]
+
+### Citation Information
+```bibtex
+[Citation when available]
+```
+
+### Contributions
+[How others can contribute to the dataset]
+
+## Related Work
+This dataset can be used with the following baseline models:
+1. GEMEL (Generative Multimodal Entity Linking)
+2. GENRE (Generative ENtity REtrieval)
+
+For more information about these baselines, visit: [Your repository URL]
+```