fix(readme): added configurations description to readme

README.md

@@ -36,7 +36,15 @@ task_categories:
 
 ### Dataset summary
 
-This dataset contains league of legends champions' quotes parsed from [fandom](https://leagueoflegends.fandom.com). There are `67394` entries with quotes from 165 league of legends characters.
+This dataset contains league of legends champions' quotes parsed from [fandom](https://leagueoflegends.fandom.com). There are `67575` entries with quotes from 165 league of legends characters.
+The dataset is available in the following configurations:
+
+1. `vanilla` - all data pulled from the website without significant modifications apart from the web page structure parsing;
+1. `quotes` - truncated version of the corpus, which does't contain sound effects;
+1. `annotated` - an extended version of the full configuration with a couple of additional columns with labels;
+1. `pulled` - same as vanilla, but sound files have been pulled from the website, and `source` column is replaced with `sound`.  
+
+For an example on the dataset usage refer to [this python notebook](https://cutt.ly/3wEKDUI9).
 
 ## Dataset structure
 
@@ -61,5 +69,7 @@ Each dataset entry therefore consists of the following fields:
 - `header` - main category of the text;
 - `subheader` - secondary category of the text (none in some cases);
 - `text` - text said by the champion or description of sound made by the champion;
-- `source` - link to the audio file;
-- `champion` - name of the champion in lowercase.
+- `source` - link to the audio file (only `vanilla` configuration);
+- `champion` - name of the champion in lowercase;
+- `quote` - binary field displaying whether corresponding text contains quote or not (only `annotated` configuration);
+- `sound` - audio data for the entry (only `pulled` configuration).

pale.py

@@ -31,7 +31,7 @@ class Pale(GeneratorBasedBuilder):
         BuilderConfig(name = 'quotes', version = VERSION, description = 'Truncated version of the corpus, which does\'t contain sound effects'),
         BuilderConfig(name = 'annotated', version = VERSION, description = 'An extended version of the full configuration with a couple of additional columns with labels'),
         BuilderConfig(name = 'vanilla', version = VERSION, description = 'All data pulled from the website without significant modifications apart from the web page structure parsing'),
-        BuilderConfig(name = 'pulled', version = VERSION, description = 'Same as vanilla, but sound files have been pulled from the website, and "source" command is replaced with "sound" column')
+        BuilderConfig(name = 'pulled', version = VERSION, description = 'Same as vanilla, but sound files have been pulled from the website, and "source" column is replaced with "sound" column')
     ]
 
     DEFAULT_CONFIG_NAME = 'quotes'