ilyocoris commited on
Commit
2c839d4
·
verified ·
1 Parent(s): edc2572

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -7
README.md CHANGED
@@ -19,7 +19,7 @@ This dataset is designed to be a resource for the empirical study of generic sen
19
 
20
  ## Data Structure
21
 
22
- The dataset is released in several files.
23
 
24
  - `sentences.csv` This is the main file, containing only the generic and quantified sentences with some metadata, as described below.
25
 
@@ -35,7 +35,7 @@ The dataset is released in several files.
35
  | `quantifier_position` | Quantifier position. Either `first_word` or `middle` if the quantifier is after the bare plural (i.e. tigers are normally striped). |
36
  | `quantifier_category` | One of `gen`, `determiner`, `adverbial`. |
37
 
38
- - In `documents/` we find the .csv for the documents from each of the five sources.
39
 
40
  | Column Name | Description |
41
  |-------------|----------------------|
@@ -43,11 +43,11 @@ The dataset is released in several files.
43
  | `text` | Context text (string). |
44
  | `source` | Source of the document. |
45
 
46
- The `doc_id` is calculated by hashing the raw string of the whole documents from <a href="https://huggingface.co/datasets/Zyphra/Zyda" target="_blank">ZYDA</a>.
47
 
48
  The following python snippet calculates the hash (`doc_id`) from the `text` of a document: `hashlib.sha1(text).hexdigest()`.
49
 
50
- Note that this repository does not contain the context documents.
51
 
52
  ## Recommended Usage
53
 
@@ -55,9 +55,9 @@ It is recommended to sample first from `sentences.csv`, finding those sentences
55
 
56
  ## Cite
57
 
58
- If you use this dataset, please cite the paper! Also feel free to contact me for any doubts or additional data.
59
 
60
- `
61
  @inproceedings{cilleruelo2025mgen,
62
  author = {Gustavo Cilleruelo Calderón and Emily Allaway and Barry Haddow and Alexandra Birch},
63
  title = {MGEN: Millions of Naturally Occurring Generics in Context},
@@ -65,4 +65,4 @@ If you use this dataset, please cite the paper! Also feel free to contact me for
65
  year = {2025},
66
  note = {Forthcoming},
67
  }
68
- `
 
19
 
20
  ## Data Structure
21
 
22
+ The dataset is released in several .csv files.
23
 
24
  - `sentences.csv` This is the main file, containing only the generic and quantified sentences with some metadata, as described below.
25
 
 
35
  | `quantifier_position` | Quantifier position. Either `first_word` or `middle` if the quantifier is after the bare plural (i.e. tigers are normally striped). |
36
  | `quantifier_category` | One of `gen`, `determiner`, `adverbial`. |
37
 
38
+ - Documents with the contexts of the generic/quantified sentences from each of the five sources.
39
 
40
  | Column Name | Description |
41
  |-------------|----------------------|
 
43
  | `text` | Context text (string). |
44
  | `source` | Source of the document. |
45
 
46
+ The `doc_id` is calculated by hashing the raw string of the whole documents from [ZYDA](https://huggingface.co/datasets/Zyphra/Zyda).
47
 
48
  The following python snippet calculates the hash (`doc_id`) from the `text` of a document: `hashlib.sha1(text).hexdigest()`.
49
 
50
+ Note that this repository does not currently contain the context documents, to download those please see [blogpost](https://gustavocilleruelo.com/mgen).
51
 
52
  ## Recommended Usage
53
 
 
55
 
56
  ## Cite
57
 
58
+ If you use this dataset, please please please cite the paper! Also feel free to contact me for any doubts or additional data!
59
 
60
+ ```
61
  @inproceedings{cilleruelo2025mgen,
62
  author = {Gustavo Cilleruelo Calderón and Emily Allaway and Barry Haddow and Alexandra Birch},
63
  title = {MGEN: Millions of Naturally Occurring Generics in Context},
 
65
  year = {2025},
66
  note = {Forthcoming},
67
  }
68
+ ```