add readme

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -1,45 +1,8 @@
-[Needs More Information]
+# WEC-Eng
+A large-scale dataset for cross-document event coreference extracted from English Wikipedia. </br>
 
-# Dataset Card for [Needs More Information]
-
-## Table of Contents
-- [Dataset Description](#dataset-description)
-  - [Dataset Summary](#dataset-summary)
-  - [Supported Tasks](#supported-tasks-and-leaderboards)
-  - [Languages](#languages)
-- [Dataset Structure](#dataset-structure)
-  - [Data Instances](#data-instances)
-  - [Data Fields](#data-instances)
-  - [Data Splits](#data-instances)
-- [Dataset Creation](#dataset-creation)
-  - [Curation Rationale](#curation-rationale)
-  - [Source Data](#source-data)
-  - [Annotations](#annotations)
-  - [Personal and Sensitive Information](#personal-and-sensitive-information)
-- [Considerations for Using the Data](#considerations-for-using-the-data)
-  - [Social Impact of Dataset](#social-impact-of-dataset)
-  - [Discussion of Biases](#discussion-of-biases)
-  - [Other Known Limitations](#other-known-limitations)
-- [Additional Information](#additional-information)
-  - [Dataset Curators](#dataset-curators)
-  - [Licensing Information](#licensing-information)
-  - [Citation Information](#citation-information)
-
-## Dataset Description
-
-- **Homepage:** [Needs More Information]
-- **Repository:** https://github.com/AlonEirew/extract-wec
+- **Repository (Code for generating WEC):** https://github.com/AlonEirew/extract-wec
 - **Paper:** https://aclanthology.org/2021.naacl-main.198/
-- **Leaderboard:** [Needs More Information]
-- **Point of Contact:** [Needs More Information]
-
-### Dataset Summary
-
-A large-scale dataset for cross-document event coreference extracted from English Wikipedia
-
-### Supported Tasks and Leaderboards
-
-[Needs More Information]
 
 ### Languages
 
@@ -49,6 +12,8 @@ English
 
 ### Data Instances
 
+
+```json
 {
         "coref_chain": 2293469,
         "coref_link": "Family Values Tour 1998",
@@ -81,6 +46,7 @@ English
   "tokens_str": "Family Values Tour 1998",
   "topic_id": -1
 }
+```
 
 ### Data Fields
 
@@ -106,62 +72,12 @@ English
 
 ### Data Splits
 
-[Needs More Information]
-
-## Dataset Creation
-
-### Curation Rationale
-
-[Needs More Information]
-
-### Source Data
-
-#### Initial Data Collection and Normalization
-
-[Needs More Information]
-
-#### Who are the source language producers?
-
-[Needs More Information]
-
-### Annotations
-
-#### Annotation process
-
-[Needs More Information]
-
-#### Who are the annotators?
-
-[Needs More Information]
-
-### Personal and Sensitive Information
-
-[Needs More Information]
-
-## Considerations for Using the Data
-
-### Social Impact of Dataset
-
-[Needs More Information]
-
-### Discussion of Biases
-
-[Needs More Information]
-
-### Other Known Limitations
-
-[Needs More Information]
-
-## Additional Information
-
-### Dataset Curators
-
-[Needs More Information]
-
-### Licensing Information
-
-[Needs More Information]
-
-### Citation Information
+- Train - Train_Event_gold_mentions.json 
+- Dev - Dev_Event_gold_mentions_validated.json
+- Test - Test_Event_gold_mentions_validated.json
+- All (without automatic filtering) - All_Event_gold_mentions_unfiltered.json 
 
-[Needs More Information]
+|                             | Train   | Valid | Test |
+| -----                       | ------ | ----- | ----  |
+| Clusters                    | 7,042  |  233  | 322   |
+| Event Mentions              | 40,529 |  1250 | 1,893 |