QubitPi commited on
Commit
1896c7c
·
verified ·
1 Parent(s): c23c545

Enhance subset naming

Browse files
Files changed (1) hide show
  1. README.md +54 -7
README.md CHANGED
@@ -11,7 +11,7 @@ language:
11
  - akk
12
  - sa
13
  configs:
14
- - config_name: Languages
15
  data_files:
16
  - split: German
17
  path: german-wiktextract-data.jsonl
@@ -27,7 +27,7 @@ configs:
27
  path: akkadian-wiktextract-data.jsonl
28
  - split: Sanskrit
29
  path: sanskrit-wiktextract-data.jsonl
30
- - config_name: Graph
31
  data_files:
32
  - split: AllLanguage
33
  path: word-definition-graph-data.jsonl
@@ -105,17 +105,64 @@ There are __two__ data subsets:
105
 
106
  > [!TIP]
107
  >
108
- > Two words are structurally similar if and only if the two shares the same\
109
  > [stem](https://en.wikipedia.org/wiki/Word_stem)
110
 
111
  Development
112
  -----------
113
 
 
 
114
  Although [the original Wiktionary dump](https://dumps.wikimedia.org/) is available, parsing it from scratch involves
115
- rather complicated process. We would probably do it in the future. At present, however, we would simply take the awesome
116
- works by [tatuylonen](https://github.com/tatuylonen/wiktextract) which has already processed it and presented it in
117
- [in JSON format](https://kaikki.org/dictionary/rawdata.html). wiktionary-data takes the
118
- __raw Wiktextract data (JSONL, one object per line)__ option.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
119
 
120
  License
121
  -------
 
11
  - akk
12
  - sa
13
  configs:
14
+ - config_name: Wiktionary
15
  data_files:
16
  - split: German
17
  path: german-wiktextract-data.jsonl
 
27
  path: akkadian-wiktextract-data.jsonl
28
  - split: Sanskrit
29
  path: sanskrit-wiktextract-data.jsonl
30
+ - config_name: Knowledge Graph
31
  data_files:
32
  - split: AllLanguage
33
  path: word-definition-graph-data.jsonl
 
105
 
106
  > [!TIP]
107
  >
108
+ > Two words are structurally similar if and only if the two shares the same
109
  > [stem](https://en.wikipedia.org/wiki/Word_stem)
110
 
111
  Development
112
  -----------
113
 
114
+ ### Data Source
115
+
116
  Although [the original Wiktionary dump](https://dumps.wikimedia.org/) is available, parsing it from scratch involves
117
+ rather complicated process. For example,
118
+ [acquiring the inflection data of most Indo-European languages on Wiktionary has already triggered some research-level efforts](https://stackoverflow.com/a/62977327).
119
+ We would probably do it in the future. At present, however, we would simply take the awesome works by
120
+ [tatuylonen](https://github.com/tatuylonen/wiktextract) which has already processed it and presented it in
121
+ [in JSONL format](https://kaikki.org/dictionary/rawdata.html). __wiktionary-data sources the data from
122
+ __raw Wiktextract data (JSONL, one object per line)__ option there.
123
+
124
+ ### Environment Setup
125
+
126
+ Get the source code:
127
+
128
+ ```console
129
+ [email protected]:QubitPi/wiktionary-data.git
130
+ cd wiktionary-data
131
+ ```
132
+
133
+ It is strongly recommended to work in an isolated environment. Install virtualenv and create an isolated Python
134
+ environment by
135
+
136
+ ```console
137
+ python3 -m pip install --user -U virtualenv
138
+ python3 -m virtualenv .venv
139
+ ```
140
+
141
+ To activate this environment:
142
+
143
+ ```console
144
+ source .venv/bin/activate
145
+ ```
146
+
147
+ or, on Windows
148
+
149
+ ```console
150
+ ./venv\Scripts\activate
151
+ ```
152
+
153
+ > [!TIP]
154
+ >
155
+ > To deactivate this environment, use
156
+ >
157
+ > ```console
158
+ > deactivate
159
+ > ```
160
+
161
+ ### Installing Dependencies
162
+
163
+ ```console
164
+ pip3 install -r requirements.txt
165
+ ```
166
 
167
  License
168
  -------