Update dataset card: rewrite the labels section, add code example for downloading repos, clean up (#2)

- Update dataset card: rewrite the labels section, add code example for downloading repos, clean up (b0e9f6b0671e4404758cf0d6c15b4eb012651539)

README.md

@@ -1,6 +1,6 @@
 ---
 dataset_info:
-- config_name: commitchronicle-py-long
+- config_name: default
   features:
   - name: hash
     dtype: string
@@ -25,7 +25,7 @@ dataset_info:
   splits:
   - name: test
     num_examples: 163
-- config_name: commitchronicle-py-long-labels
+- config_name: labels
   features:
   - name: hash
     dtype: string
@@ -46,11 +46,11 @@ dataset_info:
     num_bytes: 272359
     num_examples: 858
 configs:
-- config_name: commitchronicle-py-long
+- config_name: default
   data_files:
   - split: test
     path: commitchronicle-py-long/test-*
-- config_name: commitchronicle-py-long-labels
+- config_name: labels
   data_files:
   - split: test
     path: commitchronicle-py-long-labels/test-*
@@ -62,46 +62,35 @@ license: apache-2.0
 This is the benchmark for the Commit message generation task as part of the
 🏟️ [Long Code Arena benchmark](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
 
-The current version is a manually curated subset of the Python test set from the 🤗 [CommitChronicle dataset](https://huggingface.co/datasets/JetBrains-Research/commit-chronicle), tailored for larger commits.
+The dataset is a manually curated subset of the Python test set from the 🤗 [CommitChronicle dataset](https://huggingface.co/datasets/JetBrains-Research/commit-chronicle), tailored for larger commits. 
 
 All the repositories are published under permissive licenses (MIT, Apache-2.0, and BSD-3-Clause). The datapoints can be removed upon request.
 
 ## How-to
 
-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.
+```py
+from datasets import load_dataset
 
-   Current configs: `commitchronicle-py-long`, `commitchronicle-py-long-labels`
-
-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
-
-    configuration = "TODO"  # select a configuration
-    dataset = load_dataset("JetBrains-Research/lca-cmg", configuration, split="test")
-    ```
+dataset = load_dataset("JetBrains-Research/lca-cmg", split="test")
+```
 
-   Note that all the data we have is considered to be in the 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).
+via 🤗 Datasets. See [Git Repositories](#git-repositories) section for more details.
 
-## Dataset Structure
+## About
 
-This dataset contains three kinds of data:
+### Overview
 
-* *full data* about each commit (including modifications)
-* metadata with quality *labels*
-* compressed *git repositories*
+In total, there are 163 commits from 34 repositories. For length statistics, refer to the [notebook](https://github.com/JetBrains-Research/lca-baselines/blob/main/commit_message_generation/notebooks/cmg_data_stats.ipynb) in our repository.
 
-### Full data
+### Dataset Structure
 
-This section concerns configuration with *full data* about each commit (no `-labels` suffix).
+The dataset contains two kinds of data: data about each commit (under [`commitchronicle-py-long`](https://huggingface.co/datasets/JetBrains-Research/lca-commit-message-generation/tree/main/commitchronicle-py-long) folder) and compressed git repositories (under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-commit-message-generation/tree/main/repos) folder).
+
+#### Commits
 
 Each example has the following fields:
 
@@ -125,7 +114,7 @@ Each file modification has the following fields:
 
 Data point example:
 
-```
+```json
 {'hash': 'b76ed0db81b3123ede5dc5e5f1bddf36336f3722',
  'repo': 'apache/libcloud',
  'date': '05.03.2022 17:52:34',
@@ -138,9 +127,53 @@ Data point example:
 }    
 ```
 
-### Labels
+#### Git Repositories
+
+The compressed Git repositories for all the commits in this benchmark are stored under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory.
+
+Working with git repositories under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory is not supported directly via 🤗 Datasets. 
+You can use [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/index) package to download the repositories. The sample code is provided below:
+
+```py
+import tarfile
+from huggingface_hub import list_repo_tree, hf_hub_download
+
+
+data_dir = "..."  # replace with a path to where you want to store repositories locally
+
+for repo_file in list_repo_tree("JetBrains-Research/lca-commit-message-generation", "repos", repo_type="dataset"):
+    file_path = hf_hub_download(
+        repo_id="JetBrains-Research/lca-commit-message-generation",
+        filename=repo_file.path,
+        repo_type="dataset",
+        local_dir=data_dir,
+    )
+
+    with tarfile.open(file_path, "r:gz") as tar:
+        tar.extractall(path=os.path.join(data_dir, "extracted_repos"))
+```
+
+For convenience, we also provide a full list of files in [`paths.json`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/blob/main/paths.json).
 
-This section concerns configuration with metadata and *labels* (with `-labels` suffix).
+After you download and extract the repositories, 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).
+
+# 🏷️ Extra: commit labels
+
+To facilitate further research, we additionally provide the manual labels for all the 858 commits that made it through initial filtering. The final version of the dataset described above consists of commits labeled either 4 or 5.
+
+## How-to
+
+```py
+from datasets import load_dataset
+
+dataset = load_dataset("JetBrains-Research/lca-cmg", "labels", split="test")
+```
+
+Note that all the data we have is considered to be in the test split.
+
+## About
+
+### Dataset Structure
 
 Each example has the following fields:
 
@@ -164,7 +197,7 @@ Labels are in 1–5 scale, where:
 
 Data point example:
 
-```
+```json
 {'hash': '1559a4c686ddc2947fc3606e1c4279062cc9480f',
  'repo': 'appscale/gts',
  'date': '15.07.2018 21:00:39',
@@ -172,12 +205,4 @@ Data point example:
  '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'}
-```
-
-### Git Repositories
-
-This section concerns the [`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).
+```