Upload README.md with huggingface_hub

README.md

@@ -1,195 +1,59 @@
 ---
 language:
 - code
-license: apache-2.0
+license: cc-by-4.0
 task_categories:
+- text-classification
 - text-generation
 tags:
-- code
 - refactoring
+- software-engineering
 - java
-- benchmark
-dataset_info:
-  features:
-  - name: repo
-    dtype: string
-  - name: commit
-    dtype: string
-  - name: commit_url
-    dtype: string
-  - name: repo_url
-    dtype: string
-  - name: refactoring_count
-    dtype: int64
-  - name: refactoring_types
-    list: string
-  - name: compile_before
-    dtype: bool
-  - name: compile_after
-    dtype: bool
-  - name: tests_pass_before
-    dtype: bool
-  - name: tests_pass_after
-    dtype: bool
-  - name: test_count_before
-    dtype: int64
-  - name: test_count_after
-    dtype: int64
-  - name: pass_to_pass_tests
-    list: string
-  - name: fail_to_pass_tests
-    list: string
-  - name: is_pass_to_pass
-    dtype: bool
-  - name: pass_to_pass_count
-    dtype: int64
-  - name: fail_to_pass_count
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 272840030
-    num_examples: 983
-  download_size: 272741252
-  dataset_size: 272840030
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+- testing
+pretty_name: CS4570 Java Refactoring Benchmark (High-Resource)
+size_categories:
+- 1K<n<10K
 ---
 
-# Java Refactoring Benchmark
+# CS4570 Java Refactoring Benchmark — High-Resource Tier
+
+This dataset contains Java refactoring commits mined from **57 high-resource GitHub repositories** (≥1000 stars, ≥10 contributors).
 
-## Task
-Given a Java source file before a refactoring and the refactoring type, produce the refactored file.
+Each commit was:
+1. Detected by **RefactoringMiner 3.1.3** as containing at least one Java refactoring operation
+2. Verified by building the project and running its test suite **before and after** the commit using Docker (Maven/Gradle with JDK17/21)
 
-## Schema
-- `instance_id` — unique identifier
-- `repo` — GitHub repo (owner/name)
-- `language` — "java"
-- `base_commit` — parent SHA (before state)
-- `merge_commit` — commit where refactoring was applied
-- `refactoring_types` — list of RefactoringMiner type names detected in this commit
-- `refactoring_descriptions` — corresponding human-readable descriptions
-- `file_path` — primary changed Java file (most lines changed)
-- `source_code_before` — full file content before refactoring
-- `source_code_after` — full file content after refactoring (ground truth)
-- `diff` — full unified diff of the commit (all changed files)
-- `is_pure_refactoring` — null = not yet checked; true = no extraneous changes
-- `compile_before` / `compile_after` — null = not yet verified
-- `PASS_TO_PASS` / `FAIL_TO_PASS` — null = not yet verified
-- `created_at` — commit timestamp (ISO 8601)
-- `repo_license` — SPDX license of the source repo
-- `lines_changed` — total lines changed in the commit
+## Statistics
+| Metric | Value |
+|--------|-------|
+| Repositories | 57 |
+| Total commits with tests | 983 |
+| PASS_TO_PASS commits | 981 |
+| Unique refactoring types | 66 |
 
-## Split
-- `test`: 5857 instances from 23 repos
+## Fields
+| Field | Type | Description |
+|-------|------|-------------|
+| `repo` | string | `owner_repo` identifier |
+| `commit` | string | Git commit SHA |
+| `commit_url` | string | GitHub URL to the commit |
+| `repo_url` | string | GitHub URL to the repository |
+| `refactoring_count` | int | Number of refactorings in this commit |
+| `refactoring_types` | list[str] | Refactoring type labels from RefactoringMiner |
+| `compile_before` | bool | Did the project compile at the parent commit? |
+| `compile_after` | bool | Did the project compile after this commit? |
+| `tests_pass_before` | bool | Did ALL tests pass before? |
+| `tests_pass_after` | bool | Did ALL tests pass after? |
+| `test_count_before` | int | Number of tests before |
+| `test_count_after` | int | Number of tests after |
+| `pass_to_pass_tests` | list[str] | Tests that pass both before and after |
+| `fail_to_pass_tests` | list[str] | Tests that fail before but pass after |
+| `is_pass_to_pass` | bool | At least one P2P test exists |
+| `pass_to_pass_count` | int | Number of P2P tests |
+| `fail_to_pass_count` | int | Number of F2P tests |
 
-## Refactoring types
-{
-  "Change Variable Type": 2443,
-  "Add Method Annotation": 2338,
-  "Change Return Type": 1690,
-  "Change Parameter Type": 1595,
-  "Extract Method": 1398,
-  "Add Parameter": 1351,
-  "Rename Method": 1306,
-  "Extract Variable": 1283,
-  "Change Method Access Modifier": 1183,
-  "Rename Variable": 1089,
-  "Remove Method Annotation": 1018,
-  "Change Attribute Type": 957,
-  "Rename Parameter": 852,
-  "Remove Thrown Exception Type": 738,
-  "Add Attribute Modifier": 656,
-  "Remove Parameter": 611,
-  "Inline Variable": 595,
-  "Extract And Move Method": 586,
-  "Change Attribute Access Modifier": 572,
-  "Rename Attribute": 517,
-  "Move Method": 510,
-  "Add Class Annotation": 419,
-  "Pull Up Method": 392,
-  "Encapsulate Attribute": 310,
-  "Modify Method Annotation": 287,
-  "Move Class": 282,
-  "Add Attribute Annotation": 270,
-  "Add Method Modifier": 263,
-  "Add Thrown Exception Type": 238,
-  "Rename Class": 235,
-  "Change Class Access Modifier": 224,
-  "Modify Class Annotation": 213,
-  "Replace Variable With Attribute": 212,
-  "Remove Attribute Modifier": 211,
-  "Inline Method": 207,
-  "Move Code": 196,
-  "Remove Class Annotation": 192,
-  "Parameterize Variable": 186,
-  "Add Parameter Modifier": 185,
-  "Pull Up Attribute": 182,
-  "Invert Condition": 175,
-  "Remove Method Modifier": 174,
-  "Add Parameter Annotation": 168,
-  "Move Attribute": 155,
-  "Extract Attribute": 154,
-  "Add Variable Modifier": 148,
-  "Extract Class": 144,
-  "Remove Attribute Annotation": 142,
-  "Move And Rename Method": 133,
-  "Change Thrown Exception Type": 128,
-  "Move And Inline Method": 128,
-  "Push Down Method": 127,
-  "Remove Parameter Modifier": 109,
-  "Assert Throws": 105,
-  "Remove Parameter Annotation": 90,
-  "Replace Generic With Diamond": 90,
-  "Replace Attribute With Variable": 84,
-  "Move And Rename Class": 81,
-  "Move Source Folder": 81,
-  "Localize Parameter": 80,
-  "Merge Conditional": 80,
-  "Add Class Modifier": 71,
-  "Split Conditional": 70,
-  "Replace Anonymous With Lambda": 59,
-  "Remove Class Modifier": 57,
-  "Extract Superclass": 56,
-  "Remove Variable Modifier": 55,
-  "Extract Fixture": 52,
-  "Replace Conditional With Ternary": 48,
-  "Inline Attribute": 43,
-  "Modify Attribute Annotation": 41,
-  "Replace Anonymous With Class": 37,
-  "Try With Resources": 32,
-  "Change Type Declaration Kind": 31,
-  "Merge Parameter": 28,
-  "Push Down Attribute": 25,
-  "Extract Interface": 24,
-  "Parameterize Attribute": 23,
-  "Reorder Parameter": 23,
-  "Split Parameter": 20,
-  "Split Method": 16,
-  "Rename Package": 14,
-  "Merge Variable": 14,
-  "Move And Rename Attribute": 13,
-  "Extract Subclass": 12,
-  "Move Package": 11,
-  "Replace Loop With Pipeline": 10,
-  "Replace Pipeline With Loop": 10,
-  "Parameterize Test": 9,
-  "Remove Variable Annotation": 9,
-  "Merge Attribute": 9,
-  "Merge Catch": 9,
-  "Split Attribute": 8,
-  "Add Variable Annotation": 7,
-  "Modify Parameter Annotation": 6,
-  "Replace Conditional With Assumption": 6,
-  "Merge Class": 5,
-  "Replace Attribute": 5,
-  "Collapse Hierarchy": 4,
-  "Merge Method": 3,
-  "Split Class": 2,
-  "Split Variable": 1
-}
+## Refactoring Types
+Top types: Extract Variable, Add Method Annotation, Rename Variable, Rename Method, Inline Variable, Rename Parameter, Change Variable Type, Add Variable Modifier, Extract Method, Rename Attribute
 
-## Detection
-Mined using RefactoringMiner 3.1.3.
+## Citation
+TU Delft CS4570 — ML for Software Engineering benchmark, 2026.