README.md

---
dataset_info:
- config_name: commitchronicle-py-long
  features:
  - name: hash
    dtype: string
  - name: repo
    dtype: string
  - name: date
    dtype: string
  - name: license
    dtype: string
  - name: message
    dtype: string
  - name: mods
    struct:
    - name: diff
      list:
      - name: change_type
        dtype: string
      - name: new_path
        dtype: string
      - name: old_path
        dtype: string
      - name: diff
        dtype: string
    - name: file_src
      struct:
      - name: old_path
        dtype: string
      - name: new_path
        dtype: string
      - name: old_contents
        dtype: string
      - name: new_contents
        dtype: string
  splits:
  - name: test
    num_bytes: 1225963
    num_examples: 163
  download_size: 485771
  dataset_size: 1225963
- config_name: commitchronicle-py-long-labels
  features:
  - name: hash
    dtype: string
  - name: repo
    dtype: string
  - name: date
    dtype: string
  - name: license
    dtype: string
  - name: message
    dtype: string
  - name: label
    dtype: int8
  - name: comment
    dtype: string
  splits:
  - name: test
    num_bytes: 272359
    num_examples: 858
  download_size: 155079
  dataset_size: 272359
configs:
- config_name: commitchronicle-py-long
  data_files:
  - split: test
    path: commitchronicle-py-long/test-*
- config_name: commitchronicle-py-long-labels
  data_files:
  - split: test
    path: commitchronicle-py-long-labels/test-*
---
# LCA (CMG)

This is the data for CMG benchmark as part of LCA.

## How-to

1. Since the dataset is private, if you haven't used HF Hub before, add your token via `huggingface-cli` first:

    ```
    huggingface-cli login
    ```

2. List all the available configs via [`datasets.get_dataset_config_names`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.get_dataset_config_names) and choose an appropriate one
   

3. Load the data via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):

    ```
    from datasets import load_dataset

    configuration = "TODO"  # select a configuration
    dataset = load_dataset("JetBrains-Research/lca-cmg", configuration, split="test")
    ```

    Some notes:
      * All the data we have is considered to be in test split

## Dataset Structure

This dataset contains two kinds of data: either *full data* about each commit (including modifications) or metadata with quality *labels*.


### Full data

This section concerns configuration with *full data* about each commit (no `-labels` suffix).

Each example has the following fields:

|     **Field**      |             **Description**              |
|:------------------:|:----------------------------------------:|
|       `repo`       |            Commit repository.            |
|       `hash`       |               Commit hash.               |
|       `date`       |        Commit date.        |
|     `license`      |       Commit repository's license.       |
|     `message`      |    Commit message.    |
|       `mods`       | Modifications from commit (see below for details).  |

We consider two possible commit modifications formats:
* lists of file diffs
* full file sources before and after commit


Currently, only [CommitChronicle](https://huggingface.co/datasets/JetBrains-Research/commit-chronicle) is considered as an input source, so only the first commit modifications format is used.

### List of diffs (CommitChronicle)

Data point example:

```
{'hash': 'b76ed0db81b3123ede5dc5e5f1bddf36336f3722',
 'repo': 'apache/libcloud',
 'date': '05.03.2022 17:52:34',
 'license': 'Apache License 2.0',
 'message': 'Add tests which verify that all OpenStack driver can be instantiated\nwith all the supported auth versions.\nNOTE: Those tests will fail right now due to the regressions being\nintroduced recently which breaks auth for some versions.',
 'mods': {'diff': [{'change_type': 'MODIFY',
    'new_path': 'libcloud/test/compute/test_openstack.py',
    'old_path': 'libcloud/test/compute/test_openstack.py',
    'diff': '@@ -39,6 +39,7 @@ from libcloud.utils.py3 import u\n<...>'}],
  'file_src': None}}    
```

### Labels

This section concerns configuration with metadata and *labels* (with `-labels` suffix).

Each example has the following fields:

|     **Field**      |             **Description**              |
|:------------------:|:----------------------------------------:|
|       `repo`       |            Commit repository.            |
|       `hash`       |               Commit hash.               |
|       `date`       |        Commit date.        |
|     `license`      |       Commit repository's license.       |
|     `message`      |    Commit message.    |
|     `label`      |    Label of current commit as a target for CMG task.    |
|     `comment`      |  Comment for a label for current commit (optional, might be empty). |

Labels are in 1-5 scale, where:
* 1 – strong no
* 2 – weak no
* 3 – unsure
* 4 – weak yes
* 5 – strong yes

Data point example:

```
{'hash': '1559a4c686ddc2947fc3606e1c4279062cc9480f',
 'repo': 'appscale/gts',
 'date': '15.07.2018 21:00:39',
 'license': 'Apache License 2.0',
 'message': 'Add auto_id_policy and logs_path flags\n\nThese changes were introduced in the 1.7.5 SDK.',
 'label': 1,
 'comment': 'no way to know the version'}
```