joelniklaus commited on
Commit
89c5abc
1 Parent(s): 6f63c28

added information about how to contribute

Browse files
Files changed (1) hide show
  1. README.md +8 -0
README.md CHANGED
@@ -183,6 +183,14 @@ The file format is jsonl and three data splits are present for each configuratio
183
 
184
  ## Additional Information
185
 
 
 
 
 
 
 
 
 
186
  ### Dataset Curators
187
 
188
  [More Information Needed]
 
183
 
184
  ## Additional Information
185
 
186
+ How can I contribute a dataset to lextreme?
187
+ Please follow the following steps:
188
+ 1. Make sure your dataset is available on the huggingface hub and has a train, validation and test split.
189
+ 2. Create a pull request to the lextreme repository by adding the following to the lextreme.py file:
190
+ - Create a dict _{YOUR_DATASET_NAME} (similar to _BRAZILIAN_COURT_DECISIONS_JUDGMENT) containing all the necessary information about your dataset (task_type, input_col, label_col, etc.)
191
+ - Add your dataset to the BUILDER_CONFIGS list: `LextremeConfig(name="{your_dataset_name}", **_{YOUR_DATASET_NAME})`
192
+ - Test that it works correctly by loading your subset with `load_dataset("lextreme", "{your_dataset_name}")` and inspecting a few examples.
193
+
194
  ### Dataset Curators
195
 
196
  [More Information Needed]