Update README.md

README.md

@@ -1,3 +1,70 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+task_categories:
+- text-classification
+language:
+- fr
+pretty_name: GeoEDdA-TopoRel
+---
+
+# GeoEDdA-TopoRel
+
+
+## Dataset Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Authors:** Bin Yang, [Ludovic Moncla](https://ludovicmoncla.github.io), [Fabien Duchateau](https://perso.liris.cnrs.fr/fabien.duchateau/) and [Frédérique Laforest](https://perso.liris.cnrs.fr/flaforest/) in the framework of the [ECoDA](https://liris.cnrs.fr/projet-institutionnel/fil-2025-projet-ecoda) project.
+- **Data source:** [ARTFL Encyclopédie Project](https://artfl-project.uchicago.edu), University of Chicago
+- **Git repository:** []()
+- **Language:** French
+- **License:** cc-by-nc-4.0
+
+
+### Dataset Summary
+
+This dataset contains 2,750 labeled entries from the Encyclopédie of Diderot and d’Alembert, all classified under Geography.
+The GeoEDdA-TopoRel dataset provides a set of features used at different stages of our knowledge graph construction pipeline, which is illustrated in the figure below.
+
+<img src="EDdA2KG-pipeline.png">
+
+### Supported Tasks
+
+
+
+## Dataset Structure
+
+The dataset is provided as JSON files where each item follows the following structure:
+
+```
+{
+  "volume": "17",
+  "numero": "2303",
+  "head": "TRÉVOUX",
+  "text": "TRÉVOUX, (Géog. mod.) ancienne petite ville de France, <...> ",
+  "entryType": "Place",
+  "cardinality": "single"
+  "placeType": "Ville"
+  "placeNames": [{"start": 48,  "end": 54, "text": "France", "label": "Pays"}, {"start": 86, "end": 92, "text": "Dombes", "label": "Région"}, {"start": 118, "end": 126, "text": "la Saône", "label": "Rivière"}, <...>],
+  "spatialRelations": [{"start": 94, "end": 117, "text": "sur le bord oriental de la Saône", "label": "Adjacence"} ]
+  "segmentedDescriptions": "[]"
+}
+```
+
+Each data contains ten fields: 
+
+- `volume`: volume number of the entry from the Encyclopedie ARTFL dataset
+- `numero`: number of the entry (within the volume) from the Encyclopedie ARTFL dataset
+- `head`: entry name
+- `text`: plain text of the entry
+- "entryType": type of geography entry, possible values are: `Place`, `Person`, `Autre`
+- "cardinality": indicates whether the entry describes a single place or multiple places. Possible values: `single` or `multiple`
+- "placeType": "Ville"
+- "placeNames": [{"start": 48,  "end": 54, "text": "France", "label": "Pays"}, {"start": 86, "end": 92, "text": "Dombes", "label": "Région"}, {"start": 118, "end": 126, "text": "la Saône", "label": "Rivière"}, <...>],
+- "spatialRelations": [{"start": 94, "end": 117, "text": "sur le bord oriental de la Saône", "label": "Adjacence"} ]
+- "segmentedDescriptions": list of segmented sub-entries if cardinality is equal to `multiple`, empty list otherwise.
+
+
+## Acknowledgement
+
+The authors thank the [Computer Science Federation of Lyon (FIL)](https://fil.cnrs.fr) of the CNRS for financially supporting the ECoDA research project.