Update README.md

README.md

@@ -323,17 +323,19 @@ configs:
     path: kt/train-*
 ---
 # LCA (Bug Localization)
-This is the data for **Bug Localization** benchmark as part of LCA. 
+This is the benchmark for the Bug localization task as part of the
+🏟️ [Long Code Arena benchmark](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
+
 The bug localization problem can be formulated as follows: given an issue with a bug description and a repository snapshot in a state where the bug is reproducible, identify the files within the repository that need to be modified to address the reported bug.
 
-The dataset provides all required components for evaluation of bug localization approaches in real project-level large-scale data collected from GitHub, including:
-* Bug issue description
-* Repositories from which the content on the state of the commit SHA where the bug is reproducible can be extracted
-* List of files that should be changed in order to solve the bug
-* Other additional data and metrics, that can be useful in approach development
+The dataset provides all the required components for evaluation of bug localization approaches in real project-level large-scale data collected from GitHub, including:
+* Bug issue description;
+* Repositories, from which the content can be extracted at the state of the commit SHA where the bug is reproducible;
+* List of files that should be changed in order to solve the bug;
+* Other additional data and metrics that can be useful in developing new approaches.
 
-The collected dataset was carefully filtered, enhances with useful metrics and, what is more, manually labeled, which assures the data quality and provides a golden subset of good examples for evaluation.\
-Moreover, the dataset was splitted into several categories, naming:
+The collected dataset was carefully filtered, enhanced with useful metrics and, what's more, manually labeled, which assures the data quality and provides a golden subset of good examples for evaluation.\
+Moreover, the dataset was split into several categories, namely:
 
 | **Category**   |  **Description**  |  **Number of data points**  |
 |:------------------:|:----------------------------------------:|:----------------------------------------:|
@@ -341,16 +343,16 @@ Moreover, the dataset was splitted into several categories, naming:
 | `java` | Only `.java` files in changes | 2,522  | 
 | `kt`  | Only `.kt` files in changes | 618  |
 
-And splits, naming:
+...and splits, namely:
 | **Split**   |  **Description**  |
 |:------------------:|:----------------------------------------:|
-| `dev` | All collected data point |
-| `test` | Manually verified data point |
-| `train` | Rest data point from `dev` except `test` | 
+| `dev` | All collected datapoints |
+| `test` | Manually verified datapoints |
+| `train` | Rest of the datapoint from `dev` without `test` | 
 
-The results of evaluation of various bug localization approaches can be found in [Long Code Arena 🏟 leaderboard](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
+The results of evaluation of various bug localization approaches can be found in the [Long Code Arena 🏟 leaderboard](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
 
-The following sections will describe the utilities around the dataset as well as detailed dataset content description.
+The following sections describe the utilities around the dataset, as well as dataset content.
 
 ## How-to
 
@@ -367,7 +369,7 @@ The following sections will describe the utilities around the dataset as well as
     dataset = load_dataset("JetBrains-Research/lca-bug-localization", configuration, split=split)  
     ```
 
-* Load repos via [`hf_hub_download`](https://huggingface.co/docs/huggingface_hub/v0.20.3/en/package_reference/file_download#huggingface_hub.hf_hub_download)
+* Load repos via [`hf_hub_download`](https://huggingface.co/docs/huggingface_hub/v0.20.3/en/package_reference/file_download#huggingface_hub.hf_hub_download):
     ```py
     from huggingface_hub import hf_hub_download
     from datasets import load_dataset
@@ -399,65 +401,65 @@ The following sections will describe the utilities around the dataset as well as
         os.remove(local_repo_zip_path)
    ```
 
-* Data streaming by [HFDataSource](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/baselines/data_sources/hf_data_source.py) \
-  Besides data loading, `HFDataSource` returns data point for running baseline along with the content of the repository in the state the bug is reproducible (aka `base_sha` commit of the pull request which resloves the bug issue). \
-  All source code for working with the GitHub history of repositories (commits, diffs, etc.) are available in [`git_utils.py`](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/utils/git_utils.py) as so as example of baselines, utilizes this dataset.
+* Data streaming via [HFDataSource](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/baselines/data_sources/hf_data_source.py). 
+  Besides data loading, `HFDataSource` returns a datapoint for running the baseline along with the content of the repository at the state where the bug is reproducible (aka `base_sha` commit of the pull request that resloves the bug issue). \
+  All source code for working with the Git history of repositories (commits, diffs, etc.) is available in [`git_utils.py`](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/utils/git_utils.py), as is an example of baselines, utilizing this dataset.
 
 ### Bug localization data
 
-Each data point contains main subset of field as well as additional metrics calculated upon them. \
+Each datapoint contains the main fields, as well as additional metrics calculated on them. \
 The main fields are:
 
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
-|    `repo_owner`    |            Bug issue repository owner.            |
-|    `repo_name`    |            Bug issue repository name.            |
-|    `issue_url`      |       GitHub link to issue <br> `https://github.com/{repo_owner}/{repo_name}/issues/{issue_id}`.       |
-|    `pull_url`      |       GitHub link to pull request <br> `https://github.com/{repo_owner}/{repo_name}/pull/{pull_id}`.       |
-|    `comment_url`      |       GitHub link to comment with pull request to issue reference <br> `https://github.com/{repo_owner}/{repo_name}/pull/{pull_id}#issuecomment-{comment_id}`.       |
+|    `repo_owner`    |            Owner of the repository with the bug issue.            |
+|    `repo_name`    |            Name of the repository with the bug issue.            |
+|    `issue_url`      |       GitHub link to the issue <br> `https://github.com/{repo_owner}/{repo_name}/issues/{issue_id}`.       |
+|    `pull_url`      |       GitHub link to the pull request <br> `https://github.com/{repo_owner}/{repo_name}/pull/{pull_id}`.       |
+|    `comment_url`      |       GitHub link to the comment with a reference from pull request to issue <br> `https://github.com/{repo_owner}/{repo_name}/pull/{pull_id}#issuecomment-{comment_id}`.       |
 |    `issue_title`       | Issue title.  |
 |    `issue_body`       | Issue body.  |
-|    `base_sha`       | Pull request base SHA.  |
-|    `head_sha`        | Pull request head SHA.  |
-|    `diff_url`        | Pull request diff link between base and head SHA <br> `https://github.com/{repo_owner}/{repo_name}/compare/{base_sha}...{head_sha}`.  |
-|    `diff`       | Pull request diff content.  |
-|    `pull_create_at`       | Data of pull request creation in format yyyy-mm-ddThh:mm:ssZ.  |
-|    `repo_stars`       | Number of repo stars.  |
-|    `changed_files`*       | List of changed files parsed from diff.  |
+|    `base_sha`       | Base SHA of the pull request.  |
+|    `head_sha`        | Head SHA of the pull request.  |
+|    `diff_url`        | Link to the diff between the base and the head SHA <br> `https://github.com/{repo_owner}/{repo_name}/compare/{base_sha}...{head_sha}`.  |
+|    `diff`       | Content of the diff.  |
+|    `pull_create_at`       | Date of pull request creation in the `yyyy-mm-ddThh:mm:ssZ` format.  |
+|    `repo_stars`       | Number of stars of the repo.  |
+|    `changed_files`*       | List of the changed files parsed from diff.  |
 |    `repo_language`       | Main programming language used in the repository.  |
 |    `repo_languages`       | All programming languages used in the repository.  |
-|    `repo_license`       | Licenses assigned to the repository.  |
+|    `repo_license`       | License assigned to the repository.  |
 
-\* Excluding test files that do not contain bug causes, rather changed in order to add test for proving that bug is gone.
+\* Excluding test files that do not contain bug causes, rather changed in order to add tests for proving that the bug is gone.
 
 The metrics-related fields are:
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
-|    `changed_files_exts`       | Dict from changed files extension to count.  |
+|    `changed_files_exts`       | Dictionary from the extension of changed files to their count.  |
 |    `changed_files_count`       | Number of changed files.  |
 |    `java_changed_files_count`       | Number of changed `.java` files.  |
 |    `kt_changed_files_count`       | Number of changed `.kt` files.  |
 |    `py_changed_files_count`       | Number of changed `.py` files.  |
-|    `code_changed_files_count`       | Number of changed `.java`, `.kt` or `.py` files. |
-|    `repo_symbols_count`*       | Number of symbols in repository. |
-|    `repo_tokens_count`*       | Number of tokens** in files in repository. |
-|    `repo_lines_count`*       | Number of lines in files in repository. |
-|    `repo_files_without_tests_count`*       | Number of files in repository. |
-|    `changed_symbols_count`*       | Number of symbols in changed lines in diff. |
-|    `changed_tokens_count`*       | Number of tokens** in changed lines in diff. |
+|    `code_changed_files_count`       | Number of changed `.java`, `.kt`, or `.py` files. |
+|    `repo_symbols_count`*       | Number of symbols in the repository. |
+|    `repo_tokens_count`*       | Number of tokens** in the files of the repository. |
+|    `repo_lines_count`*       | Number of lines in the files of the repository. |
+|    `repo_files_without_tests_count`*       | Number of files in the repository. |
+|    `changed_symbols_count`*       | Number of symbols in the changed lines in diff. |
+|    `changed_tokens_count`*       | Number of tokens** in the changed lines in diff. |
 |    `changed_lines_count`*       | Number of changed lines in diff (including added and deleted). |
 |    `changed_files_without_tests_count`*       | Number of files in diff. |
-|    `issue_symbols_count`*       | Number of symbols in issue body. |
-|    `issue_words_count`*       | Number of words in issue body (separated by space symbols). |
-|    `issue_tokens_count`*       | Number of tokens** in issue body. |
-|    `issue_lines_count`*       | Number of text lines in issue body (separated by \\n). |
-|    `issue_links_count`       | Number of links (\[...\](...)) presented in issue body. |
-|    `issue_code_blocks_count`       | Number of code blocks (\`\`\`...\`\`\`) presented in issue body. |
+|    `issue_symbols_count`*       | Number of symbols in the issue body. |
+|    `issue_words_count`*       | Number of words in the issue body (separated by space symbols). |
+|    `issue_tokens_count`*       | Number of tokens** in the issue body. |
+|    `issue_lines_count`*       | Number of text lines in the issue body (separated by `\\n`). |
+|    `issue_links_count`       | Number of links (\[...\](...)) present in the issue body. |
+|    `issue_code_blocks_count`       | Number of code blocks (\`\`\`...\`\`\`) present in the issue body. |
             
-\* Excluding test files that do not contain bug causes, rather changed in order to add test for proving that bug is gone. \
+\* Excluding test files that do not contain bug causes, rather changed in order to add tests for proving that the bug is gone. \
 \*\* Using GPT-4 tokenizer via ticktoken.
   
 ### Repositories data
-The compressed repositories provided in section [repos](https://huggingface.co/datasets/JetBrains-Research/lca-bug-localization/tree/main/repos) separately from data point to provide access to the various stages of repository, saving its initial structure, as well as to reuse one's content for different data point connected to the same repository.
-To extract the required information from repositories, each zip file should be unarchived. Afterwords, we recommend to use [GitPython](https://github.com/gitpython-developers/GitPython) or [PyDriller](https://github.com/ishepard/pydriller) python library to navigate thought repository history and extract one's content on required commit or calculate diff. 
-Most of the required utility methods are provided in our repository in [`git_utils.py`](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/utils/git_utils.py), so you may reuse them to access required repository data.
+The compressed repositories are provided in the [repos](https://huggingface.co/datasets/JetBrains-Research/lca-bug-localization/tree/main/repos) section, separately from datapoints, to provide access to the various stages of repositories, saving their initial structure, as well as to reuse their content for different datapoints connected to the same repository.
+To extract the required information from repositories, each `zip` file should be unarchived. Afterwords, we recommend to use [GitPython](https://github.com/gitpython-developers/GitPython) or [PyDriller](https://github.com/ishepard/pydriller) Python libraries to navigate through the repository history and extract its content on the required commit or calculate diff. 
+Most of the required utility methods are provided in our repository in the [`git_utils.py`](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/utils/git_utils.py) file, so you may reuse them to access the required repository data.