gate-tec commited on
Commit
3ca37fd
1 Parent(s): f9233bd

Add usage examples

Browse files
Files changed (1) hide show
  1. README.md +37 -1
README.md CHANGED
@@ -102,10 +102,24 @@ This distinction is also reflected in the configuration names:
102
 
103
  <p id="p-list-base-configs">The configuration names (as replacements for <code>&lt;config&gt;</code>) in this dataset are:</p>
104
 
105
- - `main`: 8865 arguments (sources: `A`, `D`, `E`) with splits `train`, `validation`, and `test`
 
 
 
 
 
106
  - `nahjalbalagha`: 279 arguments (source: `F`) with split `test`
 
 
 
107
  - `nyt`: 80 arguments (source: `G`) with split `test`
 
 
 
108
  - `zhihu`: 100 arguments (source: `C`) with split `validation`
 
 
 
109
 
110
  Please note that due to copyright reasons, there currently does not exist a direct download link to the arguments contained in the
111
  New york Times
@@ -124,17 +138,29 @@ The following lists all configuration names for metadata. Each configuration onl
124
  - `MACE-P`: the quality label according to the MACE-P scoring function
125
  - `stance_WA`: the stance label according to the weighted-average scoring function
126
  - `stance_WA_conf`: the confidence in the stance label according to the weighted-average scoring function
 
 
 
127
  - `zhihu-meta`: Each row corresponds to one argument (IDs starting with `C`) from the Chinese question-answering website [Zhihu](https://www.zhihu.com)
128
  - `Argument ID`: The unique identifier for the argument
129
  - `Conclusion Chinese`: The original chinese conclusion statement
130
  - `Premise Chinese`: The original chinese premise statement
131
  - `URL`: Link to the original statement the argument was taken from
 
 
 
132
  - `gdi-meta`: Each row corresponds to one argument (IDs starting with `D`) from [GD IDEAS](https://www.groupdiscussionideas.com/)
133
  - `Argument ID`: The unique identifier for the argument
134
  - `URL`: Link to the topic the argument was taken from
 
 
 
135
  - `cofe-meta`: Each row corresponds to one argument (IDs starting with `E`) from [the Conference for the Future of Europe](https://futureu.europa.eu)
136
  - `Argument ID`: The unique identifier for the argument
137
  - `URL`: Link to the comment the argument was taken from
 
 
 
138
  - `nahjalbalagha-meta`: Each row corresponds to one argument (IDs starting with `F`). This file contains information on the 279 arguments in `nahjalbalagha` (or `nahjalbalagha-level1`)
139
  and 1047 additional arguments that were not labeled so far. This data was contributed by the language.ml lab.
140
  - `Argument ID`: The unique identifier for the argument
@@ -146,10 +172,16 @@ The following lists all configuration names for metadata. Each configuration onl
146
  - `Premise English`: Premise text of the argument in English (translated from Farsi)
147
  - `Source`: Source text of the argument; one of "Nahj al-Balagha", "Ghurar al-Hikam wa Durar ak-Kalim"; their Farsi translations were used
148
  - `Method`: How the premise was extracted from the source; one of "extracted" (directly taken), "deduced"; the conclusion are deduced
 
 
 
149
  - `nyt-meta`: Each row corresponds to one argument (IDs starting with `G`) from [The New York Times](https://www.nytimes.com)
150
  - `Argument ID`: The unique identifier for the argument
151
  - `URL`: Link to the article the argument was taken from
152
  - `Internet Archive timestamp`: Timestamp of the article's version in the Internet Archive that was used
 
 
 
153
  - `value-categories`: Contains a single JSON-entry with the structure of level 2 and level 1 values regarding the value taxonomy:
154
  ```
155
  {
@@ -161,6 +193,10 @@ The following lists all configuration names for metadata. Each configuration onl
161
  }, ...
162
  }
163
  ```
 
 
 
 
164
 
165
  ## Additional Information
166
 
 
102
 
103
  <p id="p-list-base-configs">The configuration names (as replacements for <code>&lt;config&gt;</code>) in this dataset are:</p>
104
 
105
+ - `main`: 8865 arguments (sources: `A`, `D`, `E`) with splits `train`, `validation`, and `test` (default configuration name)
106
+ ```python
107
+ dataset_main_train = load_dataset("webis/Touche23-ValueEval", split="train")
108
+ dataset_main_validation = load_dataset("webis/Touche23-ValueEval", split="validation")
109
+ dataset_main_test = load_dataset("webis/Touche23-ValueEval", split="test")
110
+ ```
111
  - `nahjalbalagha`: 279 arguments (source: `F`) with split `test`
112
+ ```python
113
+ dataset_nahjalbalagha_test = load_dataset("webis/Touche23-ValueEval", name="nahjalbalagha", split="test")
114
+ ```
115
  - `nyt`: 80 arguments (source: `G`) with split `test`
116
+ ```python
117
+ dataset_nyt_test = load_dataset("webis/Touche23-ValueEval", name="nyt", split="test")
118
+ ```
119
  - `zhihu`: 100 arguments (source: `C`) with split `validation`
120
+ ```python
121
+ dataset_zhihu_validation = load_dataset("webis/Touche23-ValueEval", name="zhihu", split="validation")
122
+ ```
123
 
124
  Please note that due to copyright reasons, there currently does not exist a direct download link to the arguments contained in the
125
  New york Times
 
138
  - `MACE-P`: the quality label according to the MACE-P scoring function
139
  - `stance_WA`: the stance label according to the weighted-average scoring function
140
  - `stance_WA_conf`: the confidence in the stance label according to the weighted-average scoring function
141
+ ```python
142
+ dataset_ibm_metadata = load_dataset("webis/Touche23-ValueEval", name="ibm-meta", split="meta")
143
+ ```
144
  - `zhihu-meta`: Each row corresponds to one argument (IDs starting with `C`) from the Chinese question-answering website [Zhihu](https://www.zhihu.com)
145
  - `Argument ID`: The unique identifier for the argument
146
  - `Conclusion Chinese`: The original chinese conclusion statement
147
  - `Premise Chinese`: The original chinese premise statement
148
  - `URL`: Link to the original statement the argument was taken from
149
+ ```python
150
+ dataset_zhihu_metadata = load_dataset("webis/Touche23-ValueEval", name="zhihu-meta", split="meta")
151
+ ```
152
  - `gdi-meta`: Each row corresponds to one argument (IDs starting with `D`) from [GD IDEAS](https://www.groupdiscussionideas.com/)
153
  - `Argument ID`: The unique identifier for the argument
154
  - `URL`: Link to the topic the argument was taken from
155
+ ```python
156
+ dataset_gdi_metadata = load_dataset("webis/Touche23-ValueEval", name="gdi-meta", split="meta")
157
+ ```
158
  - `cofe-meta`: Each row corresponds to one argument (IDs starting with `E`) from [the Conference for the Future of Europe](https://futureu.europa.eu)
159
  - `Argument ID`: The unique identifier for the argument
160
  - `URL`: Link to the comment the argument was taken from
161
+ ```python
162
+ dataset_cofe_metadata = load_dataset("webis/Touche23-ValueEval", name="cofe-meta", split="meta")
163
+ ```
164
  - `nahjalbalagha-meta`: Each row corresponds to one argument (IDs starting with `F`). This file contains information on the 279 arguments in `nahjalbalagha` (or `nahjalbalagha-level1`)
165
  and 1047 additional arguments that were not labeled so far. This data was contributed by the language.ml lab.
166
  - `Argument ID`: The unique identifier for the argument
 
172
  - `Premise English`: Premise text of the argument in English (translated from Farsi)
173
  - `Source`: Source text of the argument; one of "Nahj al-Balagha", "Ghurar al-Hikam wa Durar ak-Kalim"; their Farsi translations were used
174
  - `Method`: How the premise was extracted from the source; one of "extracted" (directly taken), "deduced"; the conclusion are deduced
175
+ ```python
176
+ dataset_nahjalbalagha_metadata = load_dataset("webis/Touche23-ValueEval", name="nahjalbalagha-meta", split="meta")
177
+ ```
178
  - `nyt-meta`: Each row corresponds to one argument (IDs starting with `G`) from [The New York Times](https://www.nytimes.com)
179
  - `Argument ID`: The unique identifier for the argument
180
  - `URL`: Link to the article the argument was taken from
181
  - `Internet Archive timestamp`: Timestamp of the article's version in the Internet Archive that was used
182
+ ```python
183
+ dataset_nyt_metadata = load_dataset("webis/Touche23-ValueEval", name="nyt-meta", split="meta")
184
+ ```
185
  - `value-categories`: Contains a single JSON-entry with the structure of level 2 and level 1 values regarding the value taxonomy:
186
  ```
187
  {
 
193
  }, ...
194
  }
195
  ```
196
+ As this configuration contains just a single entry, an example usage could be:
197
+ ```python
198
+ value_categories = load_dataset("webis/Touche23-ValueEval", name="value-categories", split="meta")[0]
199
+ ```
200
 
201
  ## Additional Information
202