KhalidNElmadani commited on
Commit
1aa6945
·
verified ·
1 Parent(s): 9cf131b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -15
README.md CHANGED
@@ -27,13 +27,13 @@ and enriched with automatic **morphological**, **syntactic**, and **readability*
27
  The corpus includes both document-level and sentence-level annotations.
28
 
29
  **Document-level annotations** (manually labeled):
30
- - **Domain**: Arts & Humanities, Social Sciences, or STEM
31
- - **Readership Group**: Foundational, Advanced, or Specialized
32
- - **Text Category**: Educational Materials, Literature, Art & Music, Media & Culture, Academic, Encyclopedic, or Religion & Philosophy
33
 
34
  **Sentence-level annotations** (automatically generated):
35
  - **Morphological analysis**
36
- - **Syntactic analysis**
37
  - **Readability leveling**
38
 
39
  ---
@@ -46,8 +46,7 @@ The corpus includes both document-level and sentence-level annotations.
46
 
47
  ## Corpus Details
48
 
49
- The structure of this dataset direcotry is as follows:
50
-
51
  ```
52
  .
53
  ├── Data/
@@ -61,19 +60,45 @@ The structure of this dataset direcotry is as follows:
61
 
62
  ### Metadata
63
 
64
- The data fields are:
65
-
66
- - **Document**: Document file name (without any extentions).
67
- - **Directory**: Document directory.
68
- - **Source**: Document source.
69
- - **Book**: Book name.
70
- - **Author**: Author name.
71
  - **Domain**
72
- - **Readership Group**
73
  - **Text Category**
 
 
 
74
 
75
  ### Raw Sentences
76
 
 
 
77
  ### Morphology and Readability
78
 
79
- ### Syntax
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
  The corpus includes both document-level and sentence-level annotations.
28
 
29
  **Document-level annotations** (manually labeled):
30
+ - **Domain**: `Arts & Humanities`, `Social Sciences`, or `STEM`
31
+ - **Readership Group**: `Foundational`, `Advanced`, or `Specialized`
32
+ - **Text Category**: `Educational Materials`, `Literature, Art & Music`, `Media & Culture`, `Academic`, `Encyclopedic`, or `Religion & Philosophy`
33
 
34
  **Sentence-level annotations** (automatically generated):
35
  - **Morphological analysis**
36
+ - **Syntactic parsing**
37
  - **Readability leveling**
38
 
39
  ---
 
46
 
47
  ## Corpus Details
48
 
49
+ The structure of the dataset directory is as follows:
 
50
  ```
51
  .
52
  ├── Data/
 
60
 
61
  ### Metadata
62
 
63
+ The metadata file contains the following fields:
64
+ - **Document**: Document file name (without extension)
65
+ - **Directory**: Document directory
66
+ - **Source**: Document source
67
+ - **Book**: Book title
68
+ - **Author**: Author name
 
69
  - **Domain**
70
+ - **Readership Level**
71
  - **Text Category**
72
+ - **Word Count**: Number of words in the document
73
+ - **Sentence Count**: Number of sentences in the document
74
+ - **In BAREC Corpus?**: Indicates whether the document originates from the original BAREC corpus (`Yes` or `No`)
75
 
76
  ### Raw Sentences
77
 
78
+ The corpus includes 20,535 `.txt` files containing raw sentences, organized into multiple directories according to the metadata.
79
+
80
  ### Morphology and Readability
81
 
82
+ The corpus includes 20,535 `.json` files containing morphological and readability annotations, organized into multiple directories according to the metadata.
83
+
84
+ Each JSON file represents a document and contains the following key-value pairs:
85
+
86
+ **Sentence-level features:**
87
+ - `raw_sents`: Raw sentences (list of strings)
88
+ - `sents_word_count`: Number of words per sentence (list of integers)
89
+ - `sents_RL`: Sentence-level readability scores (list of integers from 1 to 19). The value `###` indicates problematic sentences in documents originating from the BAREC corpus.
90
+
91
+ **Word-level features:**
92
+ - `word`: Tokenized words for all sentences (list of lists of strings)
93
+ - `lex`: Lemmas of all words (list of lists of strings)
94
+ - `pos`: Part-of-speech tags (list of lists of strings)
95
+ - `RL`: Readability levels of lemmas (list of lists of integers)
96
+ - `num`, `gen`, `mod`, etc.: Additional [CAMeL Morph](https://github.com/CAMeL-Lab/camel_morph) features of all words (list of lists of strings)
97
+
98
+ ### Syntax
99
+
100
+ We provide syntactic annotations in both the [Columbia Arabic Treebank (CATiB)](https://aclanthology.org/P09-2056/) and [Universal Dependencies (UD)](https://aclanthology.org/W17-1320/) schemes.
101
+
102
+ The corpus includes 20,535 `.conllx` files per annotation scheme, each containing syntactic annotations and organized into multiple directories according to the metadata.
103
+
104
+ We recommend using the [Palmyra tool](https://camel-lab.github.io/palmyra/index.html) for visualization and analysis of these files.