Icannos commited on
Commit
f312d4d
1 Parent(s): 12587f1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -1
README.md CHANGED
@@ -20,6 +20,14 @@ size_categories:
20
  This is an easy-to-use huggingface dataset to access the [lichess game database](https://database.lichess.org/). For now it supports only the standard games
21
  but other variant will be added shortly.
22
 
 
 
 
 
 
 
 
 
23
  ### Supported Tasks and Leaderboards
24
 
25
  It is intended for pretraining text generation models for chess games (in a PGN format).
@@ -39,8 +47,9 @@ dataset = load_dataset("lichess_games", "2013-06", streaming=True)
39
 
40
  Examples (3 rows from june 2013):
41
 
 
 
42
  ```
43
-
44
  {'text': '[Event "Rated Bullet game"]\n'
45
  '[Site "https://lichess.org/in28emmw"]\n'
46
  '[Date "????.??.??"]\n'
@@ -116,6 +125,9 @@ Examples (3 rows from june 2013):
116
  '30. Rg1 0-1'}
117
  ```
118
 
 
 
 
119
  ### Data Fields
120
 
121
  Only a single column "text". Each row contains a single game in PGN format.
@@ -146,6 +158,7 @@ No splits only the file per dates.
146
  ### Source Data
147
 
148
  The underlying data are provided and maintained by the Lichess team and provided under CC0 license (https://database.lichess.org/). I only provide the huggingface interface here.
 
149
 
150
  #### Initial Data Collection and Normalization
151
 
 
20
  This is an easy-to-use huggingface dataset to access the [lichess game database](https://database.lichess.org/). For now it supports only the standard games
21
  but other variant will be added shortly.
22
 
23
+ Requirements:
24
+
25
+ ```
26
+ chess
27
+ zstandard
28
+ ```
29
+
30
+
31
  ### Supported Tasks and Leaderboards
32
 
33
  It is intended for pretraining text generation models for chess games (in a PGN format).
 
47
 
48
  Examples (3 rows from june 2013):
49
 
50
+ <details>
51
+
52
  ```
 
53
  {'text': '[Event "Rated Bullet game"]\n'
54
  '[Site "https://lichess.org/in28emmw"]\n'
55
  '[Date "????.??.??"]\n'
 
125
  '30. Rg1 0-1'}
126
  ```
127
 
128
+ </details>
129
+
130
+
131
  ### Data Fields
132
 
133
  Only a single column "text". Each row contains a single game in PGN format.
 
158
  ### Source Data
159
 
160
  The underlying data are provided and maintained by the Lichess team and provided under CC0 license (https://database.lichess.org/). I only provide the huggingface interface here.
161
+ The loading script download the zstd files and reads from them on the fly without decompressing the whole file, and parses the games using python-chess.
162
 
163
  #### Initial Data Collection and Normalization
164