CONTRIBUTING.md

## Working with dataset locally

A huggingface datasets repository is a GitHub repository like any other. You can simply download it like so:

```bash
git clone https://huggingface.co/datasets/danish-foundation-models/danish-dynaword
cd danish-dynaword
git lfs pull # download large files to ensure that tests works
```

You can the work with the dataset locally like so:

```py
from datasets import load_dataset

name = "../."  # instead of "danish-foundation-models/danish-dynaword"
dataset = load_dataset("../.", split="train")
# make transformations here
```

> 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`.

## Adding a new dataset

To add a new dataset you will have to create a folder under `data/{dataset_name}/`, which should look as follows:

```
  data/dataset_name
  |- dataset_name.md
  |- dataset_name.parquet
  |- create.py               # optional
```

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 
dataset with fixes or update the dataset to the latest version using an API.

## Installing dependencies

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:

```bash
make install
```

## Running dataset tests

This dataset is special as it comes with a test suite, e.g. testing in the ids are unique and that the format is consistent. You can run the suite using

```bash
make test
```

## Submitting a PR

Creating a PR on Huggingface is a bit different from creating one on Github.

1) Go to the community tab on huggingface press *new pull request* and choose *on your machine*. Specify the title of the your PR. Then you can simply:

```bash
git checkout -b {new branch name}
# make your changes here 

# push to hub
# you might need to first login:
# huggingface-cli login
git push origin HEAD:refs/pr/{PR NUMBER}
```
Where HEAD refers to the current branch. 

Before you make the PR do be sure to make sure that you have completed the checklist below.

### Making changes to an existing PR

As a contributor you might need to develop on an existing branch. To do so you you 
```bash
# fetch and checkout existing branch:
git fetch origin refs/pr/{PR NUMBER}:pr/{PR NUMBER}
git checkout pr/{PR NUMBER}
# make your changes here

# push changes
```

### Checklist

- [ ] I have run the test suite using `make test` and all tests pass
- [ ] I have added/changed a dataset:
  - [ ] I have updated descriptive statistics using `make update-descriptive-statistics`
  - [ ] I have bumped the version use `make bump-version`
- [ ] 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.
- [ ] I have updated the CHANGELOG.md if appropriate 


### Examples of Previous PRs
To see example PR you can see the following:

- [Restructuring columns in the dataset](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions/11)
- [Adding a new dataset](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions/15)
- Updated [dataset description and metadata](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions/20)

## Frequently asked questions

### Do you accept synthetic dataets

Yes we do generally accept synthetic datasets since it will likely be a promising research direction for low- to mid-resource languages.
However, you should be aware that synthetic dataset will probably require a more detailed examination and description.
We will for instance examine the quality of the synthetic subset and whether the model used for the creation permits resharing of the synthetic data under permissible licenses.

### Do you accept non-Danish data

Generally this repository is intended for Danish text, however quite broadly defined. For instance, we do accept data containing [code-switching](https://www.google.com/search?client=safari&rls=en&q=code+switching&ie=UTF-8&oe=UTF-8) and historical Danish text.