Update README.md

README.md

@@ -432,11 +432,11 @@ The bug localization problem can be formulated as follows: given an issue with a
 
 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
-* Repository content with the commit SHA where the bug is reproducible
+* 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 collected dataset was carefully filtered, inhances with useful metrics and, what is more, manually labeled, which assures the data quality and provides a golden subset of good examples for evaluation.
+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.
 The following sections will describe the utilities around the dataset as well as detailed dataset content description.
 
 ## How-to
@@ -489,15 +489,11 @@ The following sections will describe the utilities around the dataset as well as
 * 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.
-  
-## Dataset Structure
-
-TODO: some overall structure or repo
 
 ### Bug localization data
 
-Each data point contains main subset of field as well as additional metrics calculated upon them. 
-The core fields are:
+Each data point contains main subset of field as well as additional metrics calculated upon them. \
+The main fields are:
 
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
@@ -521,7 +517,7 @@ The core fields are:
 
 \* Excluding test files that do not contain bug causes, rather changed in order to add test for proving that bug is gone.
 
-The metrics fields are:
+The metrics-related fields are:
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
 |    `changed_files_exts`       | Dict from changed files extension to count.  |
@@ -548,6 +544,7 @@ The metrics fields are:
 \* Excluding test files that do not contain bug causes, rather changed in order to add test for proving that bug is gone. \
 \*\* Using GPT-4 tokenizer via ticktoken.
   
-### Repos data
-
-TODO: describe repos data as `.zip` archives with list of repos metadata
+### Repositories data
+The compressed repositories provided in section [repo](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.