KennethEnevoldsen commited on
Commit
8efe7c3
·
unverified ·
1 Parent(s): 08ad838

Updated CONTRIBUTING.md

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +15 -0
CONTRIBUTING.md CHANGED
@@ -20,6 +20,20 @@ dataset = load_dataset("../.", split="train")
20
 
21
  > Note: While it is local Huggingface still uses a cache, therefore you might need to reset it after changes have been made to see that it works correctly. You can do this by deleting the cached files which you can locate using `dataset.cache_files`.
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ## Installing dependencies
24
 
25
  This repo comes with a few dependencies you need to install to make this run. It uses a [makefile](https://opensource.com/article/18/8/what-how-makefile) to run commands and a [uv](https://docs.astral.sh/uv/) for package management. Once you have uv installed you can install the dependencies using:
@@ -58,6 +72,7 @@ Before you make the PR do be sure to make sure that you have completed the follo
58
  - [ ] I have added/changed a dataset and have
59
  - [ ] I have updated descriptive statistics using `make update-descriptive-statistics`
60
  - [ ] I have bumped the version use `make bump-version`
 
61
 
62
  ### Examples of Previous PRs
63
  To see example PR you can see the following:
 
20
 
21
  > Note: While it is local Huggingface still uses a cache, therefore you might need to reset it after changes have been made to see that it works correctly. You can do this by deleting the cached files which you can locate using `dataset.cache_files`.
22
 
23
+ ## Adding a new dataset
24
+
25
+ To add a new dataset you will have to create a folder under `data/{dataset_name}/`, which should look as follows:
26
+
27
+ ```
28
+ data/dataset_name
29
+ |- dataset_name.md
30
+ |- dataset_name.parquet
31
+ |- create.py # optional
32
+ ```
33
+
34
+ The create.py is an optional python script that allow you to recreate the dataset from the source. This is typically to allow us to reproduce the
35
+ dataset with fixes or update the dataset to the latest version using an API.
36
+
37
  ## Installing dependencies
38
 
39
  This repo comes with a few dependencies you need to install to make this run. It uses a [makefile](https://opensource.com/article/18/8/what-how-makefile) to run commands and a [uv](https://docs.astral.sh/uv/) for package management. Once you have uv installed you can install the dependencies using:
 
72
  - [ ] I have added/changed a dataset and have
73
  - [ ] I have updated descriptive statistics using `make update-descriptive-statistics`
74
  - [ ] I have bumped the version use `make bump-version`
75
+ - [ ] If I have added a `create.py` script I have added the [script dependencies](https://docs.astral.sh/uv/guides/scripts/#declaring-script-dependencies) required to run that script.
76
 
77
  ### Examples of Previous PRs
78
  To see example PR you can see the following: