README.md

---
dataset_info:
- config_name: android
  features:
  - name: full_name
    dtype: string
  - name: owner
    dtype: string
  - name: name
    dtype: string
  - name: html_url
    dtype: string
  - name: is_template
    dtype: bool
  - name: description
    dtype: string
  - name: template_keywords
    dtype: string
  - name: license
    dtype: string
  - name: topics
    dtype: string
  - name: size
    dtype: int64
  - name: language
    dtype: string
  - name: created_at
    dtype: string
  - name: updated_at
    dtype: string
  - name: gpt_description
    dtype: string
  - name: repo_symbols_count
    dtype: int64
  - name: repo_tokens_count
    dtype: int64
  - name: repo_words_count
    dtype: int64
  - name: repo_lines_count
    dtype: int64
  - name: repo_files_count
    dtype: int64
  - name: repo_code_symbols_count
    dtype: int64
  - name: repo_code_tokens_count
    dtype: int64
  - name: repo_code_words_count
    dtype: int64
  - name: repo_code_lines_count
    dtype: int64
  - name: repo_code_files_count
    dtype: int64
  - name: description_symbols_count
    dtype: int64
  - name: description_tokens_count
    dtype: int64
  - name: description_words_count
    dtype: int64
  - name: description_lines_count
    dtype: int64
  - name: readme
    dtype: string
  - name: readme_symbols_count
    dtype: int64
  - name: readme_tokens_count
    dtype: int64
  - name: readme_words_count
    dtype: int64
  - name: readme_lines_count
    dtype: int64
  splits:
  - name: dev
    num_bytes: 66452
    num_examples: 17
  - name: test
    num_bytes: 2256
    num_examples: 1
  - name: train
    num_bytes: 64167
    num_examples: 16
  download_size: 153425
  dataset_size: 132875
- config_name: java
  features:
  - name: full_name
    dtype: string
  - name: owner
    dtype: string
  - name: name
    dtype: string
  - name: html_url
    dtype: string
  - name: is_template
    dtype: bool
  - name: description
    dtype: string
  - name: template_keywords
    dtype: string
  - name: license
    dtype: string
  - name: topics
    dtype: string
  - name: size
    dtype: int64
  - name: language
    dtype: string
  - name: created_at
    dtype: string
  - name: updated_at
    dtype: string
  - name: gpt_description
    dtype: string
  - name: repo_symbols_count
    dtype: int64
  - name: repo_tokens_count
    dtype: int64
  - name: repo_words_count
    dtype: int64
  - name: repo_lines_count
    dtype: int64
  - name: repo_files_count
    dtype: int64
  - name: repo_code_symbols_count
    dtype: int64
  - name: repo_code_tokens_count
    dtype: int64
  - name: repo_code_words_count
    dtype: int64
  - name: repo_code_lines_count
    dtype: int64
  - name: repo_code_files_count
    dtype: int64
  - name: description_symbols_count
    dtype: int64
  - name: description_tokens_count
    dtype: int64
  - name: description_words_count
    dtype: int64
  - name: description_lines_count
    dtype: int64
  - name: readme
    dtype: string
  - name: readme_symbols_count
    dtype: int64
  - name: readme_tokens_count
    dtype: int64
  - name: readme_words_count
    dtype: int64
  - name: readme_lines_count
    dtype: int64
  splits:
  - name: dev
    num_bytes: 315460
    num_examples: 81
  - name: test
    num_bytes: 32962
    num_examples: 10
  - name: train
    num_bytes: 283136
    num_examples: 71
  download_size: 385352
  dataset_size: 631558
- config_name: kt
  features:
  - name: full_name
    dtype: string
  - name: owner
    dtype: string
  - name: name
    dtype: string
  - name: html_url
    dtype: string
  - name: is_template
    dtype: bool
  - name: description
    dtype: string
  - name: template_keywords
    dtype: string
  - name: license
    dtype: string
  - name: topics
    dtype: string
  - name: size
    dtype: int64
  - name: language
    dtype: string
  - name: created_at
    dtype: string
  - name: updated_at
    dtype: string
  - name: gpt_description
    dtype: string
  - name: repo_symbols_count
    dtype: int64
  - name: repo_tokens_count
    dtype: int64
  - name: repo_words_count
    dtype: int64
  - name: repo_lines_count
    dtype: int64
  - name: repo_files_count
    dtype: int64
  - name: repo_code_symbols_count
    dtype: int64
  - name: repo_code_tokens_count
    dtype: int64
  - name: repo_code_words_count
    dtype: int64
  - name: repo_code_lines_count
    dtype: int64
  - name: repo_code_files_count
    dtype: int64
  - name: description_symbols_count
    dtype: int64
  - name: description_tokens_count
    dtype: int64
  - name: description_words_count
    dtype: int64
  - name: description_lines_count
    dtype: int64
  - name: readme
    dtype: string
  - name: readme_symbols_count
    dtype: int64
  - name: readme_tokens_count
    dtype: int64
  - name: readme_words_count
    dtype: int64
  - name: readme_lines_count
    dtype: int64
  splits:
  - name: dev
    num_bytes: 114192
    num_examples: 21
  - name: test
    num_bytes: 81712
    num_examples: 12
  - name: train
    num_bytes: 33039
    num_examples: 9
  download_size: 197513
  dataset_size: 228943
- config_name: py
  features:
  - name: full_name
    dtype: string
  - name: owner
    dtype: string
  - name: name
    dtype: string
  - name: html_url
    dtype: string
  - name: is_template
    dtype: bool
  - name: description
    dtype: string
  - name: template_keywords
    dtype: string
  - name: license
    dtype: string
  - name: topics
    dtype: string
  - name: size
    dtype: int64
  - name: language
    dtype: string
  - name: created_at
    dtype: string
  - name: updated_at
    dtype: string
  - name: gpt_description
    dtype: string
  - name: repo_symbols_count
    dtype: int64
  - name: repo_tokens_count
    dtype: int64
  - name: repo_words_count
    dtype: int64
  - name: repo_lines_count
    dtype: int64
  - name: repo_files_count
    dtype: int64
  - name: repo_code_symbols_count
    dtype: int64
  - name: repo_code_tokens_count
    dtype: int64
  - name: repo_code_words_count
    dtype: int64
  - name: repo_code_lines_count
    dtype: int64
  - name: repo_code_files_count
    dtype: int64
  - name: description_symbols_count
    dtype: int64
  - name: description_tokens_count
    dtype: int64
  - name: description_words_count
    dtype: int64
  - name: description_lines_count
    dtype: int64
  - name: readme
    dtype: string
  - name: readme_symbols_count
    dtype: int64
  - name: readme_tokens_count
    dtype: int64
  - name: readme_words_count
    dtype: int64
  - name: readme_lines_count
    dtype: int64
  splits:
  - name: dev
    num_bytes: 2609044
    num_examples: 565
  - name: test
    num_bytes: 48058
    num_examples: 10
  - name: train
    num_bytes: 2561719
    num_examples: 555
  download_size: 2735714
  dataset_size: 5218821
configs:
- config_name: android
  data_files:
  - split: dev
    path: android/dev-*
  - split: test
    path: android/test-*
  - split: train
    path: android/train-*
- config_name: java
  data_files:
  - split: dev
    path: java/dev-*
  - split: test
    path: java/test-*
  - split: train
    path: java/train-*
- config_name: kt
  data_files:
  - split: dev
    path: kt/dev-*
  - split: test
    path: kt/test-*
  - split: train
    path: kt/train-*
- config_name: py
  data_files:
  - split: dev
    path: py/dev-*
  - split: test
    path: py/test-*
  - split: train
    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.

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:
* `Python`, `Java`, `Kotlin` programming languages 
* 10+ stars
* 10-1000 code lines
* updated after 2023-01-01 00:00
* not forks
* permissive licenses (`MIT License`, `Apache License 2.0`, `BSD 3-Clause "New" or "Revised" License`, `BSD 2-Clause "Simplified" License`)
* 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 

## Dataset Description

|     **Field**      |             **Description**              |
|:------------------:|:----------------------------------------:|
|    `id`    | Identifier of data point.            |
|    `full_name`    | Repository full name `{owner}/{name}`.            |
|    `owner`    |            Bug issue repository owner.            |
|    `name`    |            Bug issue repository name.            |
|    `html_url`      |       GitHub link to issue <br> `https://github.com/{owner}/{name}`.       |
|    `is_template`      |       True if the repositories marked as a template, otherwise False.       |
|    `description`      |       Repository description.       |
|    `template_keywords`       | Template-related keywords.  |
|    `license`       | Repository license <br> (one from 'MIT License', 'Apache License 2.0', <br> 'BSD 3-Clause "New" or "Revised" License', 'BSD 2-Clause "Simplified" License').  |
|    `topics`       | Repository topics.    |
|    `size`        | Repo size \[MB\].  |
|    `metrics`        | Dict from languages to their meta info like lines count.  |
|    `languages`        | Repo languages.  |
|    `language`        | Repo main language.  |
|    `created_at`        | Date of the repo was created in format of yyyy-mm-dd hh:mm:ss.  |
|    `updated_at`        | Date of the last repo update in format of yyyy-mm-dd hh:mm:ss.  |
|    `code_lines`        | Number of lines of code in repo.  |
| `repo_symbols_count`         | Number of symbols in the repository.                   |
| `repo_tokens_count`          | Number of tokens in the repository.                    |
| `repo_words_count`           | Number of words in the repository.                     |
| `repo_lines_count`           | Number of lines in the repository.                     |
| `repo_files_count`           | Number of files in the repository.                     |
| `repo_code_symbols_count`    | Number of code symbols in the repository.              |
| `repo_code_tokens_count`*      | Number of code tokens in the repository.               |
| `repo_code_words_count`      | Number of code words in the repository.                |
| `repo_code_lines_count`      | Number of code lines in the repository.                |
| `repo_code_files_count`      | Number of code files in the repository.                |
| `description_symbols_count`  | Number of symbols in the repository description.       |
| `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`              | 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)


## 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

from datasets import load_dataset
# Select a configuration from ["java", "kt", "android"]
configuration = "java"
# Select a split from ["dev", "train", "test"]
split = "dev"
# Load data
dataset = load_dataset("JetBrains-Research/template-generation", configuration, split=split)
```