Update README.md

README.md

@@ -429,12 +429,14 @@ configs:
 # LCA (Bug Localization)
 This is the data for **Bug Localization** benchmark as part of LCA. 
 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 reports
-* Repository content with the commit sha where the bug is reproducible
+* Bug issue description
+* Repository content with 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 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 following sections will describe the utilities around the dataset as well as detailed dataset content description.
 
 ## How-to
@@ -494,9 +496,8 @@ TODO: some overall structure or repo
 
 ### Bug localization data
 
-This section concerns configuration with *full data* about each commit (no `-labels` suffix).
-
-Each example has the following fields:
+Each data point contains main subset of field as well as additional metrics calculated upon them. 
+The core fields are:
 
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
@@ -507,27 +508,47 @@ Each example has the following fields:
 |    `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}`.       |
 |    `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 url between base and head sha <br> `https://github.com/{repo_owner}/{repo_name}/compare/{base_sha}...{head_sha}`.  |
+|    `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.  |
-|    `changed_files`       | List of changed files parsed from diff.  |
+|    `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.  |
+|    `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.  |
+
+* 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:
+|     **Field**      |             **Description**              |
+|:------------------:|:----------------------------------------:|
+
 |    `changed_files_exts`       | Dict from changed files extension to 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. |
-|    `issue_tokens_count`*       | Number of tokens* in issue body (separated by \\n). |
+|    `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. |
+|    `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. |
-|    `pull_create_at`       | Data of pull request creation in format yyyy-mm-ddThh:mm:ssZ.  |
-|    `repo_stars`       | Number of repo stars.  |
-|    `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.  |
-
+            
+* 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