Update README.md

README.md

@@ -387,11 +387,40 @@ configs:
     path: py/train-*
 ---
 # Template Generation Dataset for AI Agents Evaluation
+This is the benchmark for the Project Template Generation task, which requires creating a project template (content and structure) by short textual description.
 
-## Data Collection
+The dataset provides all the required components for evaluation of project template generation approaches in real project templates collected from GitHub, including:
+* Repository description;
+* Repository root README.md file content;
+* Repository link by which the \"golden\" template can be accessed;
+* GitHub repository telemetry, including additional data and metrics that can be useful in developing new approaches.
+
+All the repositories are published under permissive licenses (MIT, Apache-2.0, BSD-3-Clause, and BSD-2-Clause). The datapoints can be removed upon request.
+
+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**  |
+|:------------------:|:----------------------------------------:|:----------------------------------------:|
+| `py` | Repositories with Python main language | 565 |
+| `java` | Repositories with Java main language | 81  | 
+| `kt`  | Repositories with Kotlin main language | 19  |
+| `android`  | Repositories with Kotlin/Java main language based on Android sdk | 17  |
+
+...and splits, namely:
+| **Split**   |  **Description**  |
+|:------------------:|:----------------------------------------:|
+| `dev` | All collected datapoints |
+| `test` | Manually verified datapoints |
+| `train` | Rest of the datapoint from `dev` without `test` | 
+
+The following sections describe the utilities around the dataset, as well as dataset content.
+
+
+## Dataset Collection
 
 This dataset contains information about repos (initially gathered from https://seart-ghs.si.usi.ch) matching the following criteria:
-* `Java`, `Kotlin`, `Python` programming languages 
+* `Python`, `Java`, `Kotlin` programming languages 
 * 10+ stars
 * 10-1000 code lines
 * updated after 2023-01-01 00:00
@@ -400,9 +429,9 @@ This dataset contains information about repos (initially gathered from https://s
 * filtered by `is_template=True` or template-related keywords presence in the description (`template`, `boilerplate`, `starter`, `skeleton`, `blueprint`, `scaffold`, `pattern`, `seed`, `example`, `demo`, `sample`, `showcase`, `illustration`, `exemplar`, `use case`, `prototype`) 
 * android is moved to separate category (by `android` keyword in description or repo `fill_name`)
 
-You can find all scripts to reproduce dataset collection in our [GitHub ](https://github.com/JetBrains-Research/agents-eval) repository 
+You can find all scripts to reproduce dataset collection in our [GitHub](https://github.com/JetBrains-Research/agents-eval) repository 
 
-## Final Dataset Description
+## Dataset Description
 
 |     **Field**      |             **Description**              |
 |:------------------:|:----------------------------------------:|
@@ -437,15 +466,21 @@ You can find all scripts to reproduce dataset collection in our [GitHub ](https:
 | `description_tokens_count`*   | Number of tokens in the repository description.        |
 | `description_words_count`    | Number of words in the repository description.         |
 | `description_lines_count`    | Number of lines in the repository description.         |
-| `readme_header`              | The header of the repository README.                   |
-| `readme_header_symbols_count`| Number of symbols in the repository README header.     |
-| `readme_header_tokens_count`*  | Number of tokens in the repository README header.      |
-| `readme_header_words_count`  | Number of words in the repository README header.       |
-| `readme_header_lines_count`  | Number of lines in the repository README header.       |
+| `readme`              | Root README.md repository content.                   |
+| `readme_symbols_count`| Number of symbols in the repository `readme`.     |
+| `readme_header_tokens_count`*  | Number of tokens in the repository `readme`.      |
+| `readme_header_words_count`  | Number of words in the repository `readme`.       |
+| `readme_header_lines_count`  | Number of lines in the repository `readme`.       |
+
+\* Tokens calculated via GPT-4 tokenizer
+
+
+## Dataset analysis
+* Topics analysis [notebook](https://github.com/JetBrains-Research/agents-eval/blob/main/src/template_generation/notebooks/topics_analysis.ipynb)
+* Large-scale analysis [notebook](https://github.com/JetBrains-Research/agents-eval/blob/main/src/template_generation/notebooks/templates_analysis.ipynb)
 
-Tokens calcualted for GPT-4 tokenizer
 
-## How to
+## Dataset usage
 * Load the data via [load_dataset](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
 ```python