Fix diffs format and update README accordingly

README.md

@@ -13,33 +13,18 @@ dataset_info:
   - name: message
     dtype: string
   - name: mods
-    struct:
-    - name: diff
-      list:
+    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
+      - name: diff
         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
@@ -60,8 +45,6 @@ dataset_info:
   - name: test
     num_bytes: 272359
     num_examples: 858
-  download_size: 155079
-  dataset_size: 272359
 configs:
 - config_name: commitchronicle-py-long
   data_files:
@@ -72,22 +55,29 @@ configs:
   - split: test
     path: commitchronicle-py-long-labels/test-*
 ---
+
 # 🏟️ Long Code Arena (Commit Message Generation)
 
-This is the benchmark for Commit Message Generation task as part of 🏟️ Long Code Arena benchmark.
+This is the benchmark for Commit Message Generation task as part of
+🏟️ [Long Code Arena benchmark](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
 
 ## How-to
 
-1. Since the dataset is private, if you haven't used HF Hub before, add your token via `huggingface-cli` first:
+> Temporary: While the dataset is private, if you haven't used HF Hub before, add your token via `huggingface-cli`
+> first:
+>
+>    ```
+>    huggingface-cli login
+>    ```
 
-    ```
-    huggingface-cli login
-    ```
+1. 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.
 
-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
-   
+   Current configs: `commitchronicle-py-long`, `commitchronicle-py-long-labels`
 
-3. Load the data via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
+2. 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
@@ -96,41 +86,44 @@ This is the benchmark for Commit Message Generation task as part of 🏟️ Long
     dataset = load_dataset("JetBrains-Research/lca-cmg", configuration, split="test")
     ```
 
-    Note that all the data we have is considered to be inthe  test split.
+   Note that all the data we have is considered to be in the test split.
 
-**Note.** Working with git repositories under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory is not supported via 🤗 Datasets. Download and extract the contents of each repository. We provide a full list of files in [`paths.json`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/blob/main/paths.json).
+**Note.** Working with git repositories
+under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory is not supported
+via 🤗 Datasets. Download and extract the contents of each repository. We provide a full list of files
+in [`paths.json`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/blob/main/paths.json).
 
 ## Dataset Structure
 
-This dataset contains three kinds of data: 
+This dataset contains three kinds of data:
+
 * *full data* about each commit (including modifications)
 * metadata with quality *labels*
 * compressed *git repositories*
 
-
 ### 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
+| **Field** |              **Description**              |
+|:---------:|:-----------------------------------------:|
+|  `repo`   |            Commit repository.             |
+|  `hash`   |               Commit hash.                |
+|  `date`   |               Commit date.                |
+| `license` |       Commit repository's license.        |
+| `message` |              Commit message.              |
+|  `mods`   | List of file modifications from a commit. |
 
+Each file modification has the following fields:
 
-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)
+|   **Field**   |                                          **Description**                                          |
+|:-------------:|:-------------------------------------------------------------------------------------------------:|
+| `change_type` | Type of change to current file. One of: `ADD`, `COPY`, `RENAME`, `DELETE`, `MODIFY` or `UNKNOWN`. |
+|  `old_path`   |                           Path to file before change (might be empty).                            |
+|  `new_path`   |                            Path to file after change (might be empty).                            |
+|    `diff`     |                                   `git diff` for current file.                                    |
 
 Data point example:
 
@@ -153,17 +146,18 @@ This section concerns configuration with metadata and *labels* (with `-labels` s
 
 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). |
+| **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
@@ -184,4 +178,8 @@ Data point example:
 
 ### Git Repositories
 
-This section concerns [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory, which stores compressed Git repositories for all the commits in this benchmark. After you download and extract it, you can work with each repository either via Git or via Python libraries like [GitPython](https://github.com/gitpython-developers/GitPython) or [PyDriller](https://github.com/ishepard/pydriller).
+This section concerns [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory,
+which stores compressed Git repositories for all the commits in this benchmark. After you download and extract it, you
+can work with each repository either via Git or via Python libraries
+like [GitPython](https://github.com/gitpython-developers/GitPython)
+or [PyDriller](https://github.com/ishepard/pydriller).

commitchronicle-py-long/test-00000-of-00001-c91b0bca349ab4a3.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:eb12f042956721bc8767ae5794d085996a632390b9f49deec4c7a2eef63161a1
-size 485771
+oid sha256:4a7e066894e692a1d1e94a5d94676c1c4bd8cab75ac7fa158476eeb51ab413cb
+size 537336