Update README.md

README.md

@@ -5,21 +5,68 @@ task_categories:
 - text-generation
 language:
 - en
-pretty_name: Relation Extraction for Inverse Relations from FewRel
+pretty_name: Relation Extraction for Inverse Relations (FewRel & TekGen)
 size_categories:
 - 1K<n<10K
+tags:
+- relation-extraction
+- nlp
+- dataset-robustness
+- inverse-relations
 ---
 
-This dataset is generated from FewRel benchmak dataset.
-Relation pairs like:
-```bash
-Child <-> Mother
+# Relation Extraction for Inverse Relations
 
-Child <-> Father
+This dataset is designed to evaluate the robustness of Relation Extraction (RE) models, specifically focusing on **Inverse Relations** and entity substitution. It is derived from the **FewRel** and **TekGen** benchmarks.
 
-Follows <-> Followed_by
+## Dataset Summary
 
-Has Part <-> Part of
-```
+The primary goal of this dataset is to test if models can recognize a relationship regardless of the direction or the surface form of the entities. It includes:
+1.  **Inverse Mapping**: Every sample includes both the forward relation (e.g., *Mother*) and its logical inverse (e.g., *Child*).
+2.  **Artificial Substitutions**: A version of the dataset where real-world entities are replaced with synthetic names (e.g., replacing "Denmark" with "Emilyfort") to test if models rely on memorized entity knowledge rather than linguistic context.
 
-Its repository is : https://github.com/sefeoglu/inverserelations
+### Relation Examples
+| Forward Relation | Inverse Relation |
+| :--- | :--- |
+| **Child** (P40) | **Mother** (P25) |
+| **Child** (P40) | **Father** (P22) |
+| **Follows** (P155) | **Followed by** (P156) |
+| **Has Part** (P527) | **Part of** (P361) |
+
+## Dataset Structure
+
+The dataset is provided in JSON format and split into four main distributions:
+
+* **Original FewRel/TekGen**: The ground-truth sentences and relations.
+* **Artificial FewRel/TekGen**: Sentences where entities have been substituted with synthetic placeholders.
+* **Relation Metadata**: Supplemental files providing human-readable definitions for Wikidata P-IDs and TekGen relation strings.
+
+### Key Fields
+* `tokens`: The input text (tokenized or raw string).
+* `head` / `tail`: The subject and object entities.
+* `head_to_tail`: The ID/Name of the forward relation.
+* `tail_to_head`: The ID/Name of the inverse relation.
+* `artificial_data`: A mapping showing which `Original` entities were changed to which `Artifical` placeholders.
+
+## Usage
+
+You can load this dataset for tasks such as:
+* **Text Classification**: Predicting the relation ID between two entities.
+* **Text Generation**: Generating a sentence that expresses a specific inverse relation.
+
+### Repository
+For scripts and more technical details on how the artificial data was generated, visit the official repository:
+👉 [sefeoglu/inverserelations](https://github.com/sefeoglu/inverserelations)
+
+## Citation
+If you use this dataset in your research, please cite the original FewRel/TekGen papers and this repository.
+
+```bibtex
+@misc{fewrel_inverse_2024,
+  author = {Sefeoglu},
+  title = {Relation Extraction for Inverse Relations from FewRel},
+  year = {2024},
+  publisher = {GitHub/HuggingFace},
+  journal = {GitHub repository},
+  howpublished = {\url{[https://github.com/sefeoglu/inverserelations](https://github.com/sefeoglu/inverserelations)}}
+}