Update README.md

README.md

@@ -52,30 +52,13 @@ configs:
 # Dataset Summary
 KStack is the largest collection of permissively licensed Kotlin code.
 ![banner](https://huggingface.co/datasets/JetBrains/KStack/resolve/main/banner.png)
-## Column description
-The dataset contains the following columns: 
-
- - `size` — size of the file in bytes  
- - `content` — text (content) of the file after removing personal identifiable information
- - `repo_id` — GitHub ID of the repository  
- - `path` — path to a file  
- - `owner` — repo owner on GitHub  
- - `name` — repo name on GitHub  
- - `commit_sha` — hash of the commit, from which the revision of the file is taken  
- - `stars` — number of stars in the repo at the moment of collection  
- - `forks` — number of forks in the repo at the moment of collection  
- - `issues` — number of issues in the repo at the moment of collection  
- - `is_fork` — `true` if the repo is a fork or not as defined by GitHub
- - `main_language` — main language of the repo as defined by GitHub  
- - `languages_distribution` — JSON with the distribution of languages by size in bytes in the repo
- - `license` - the name of the permissive license
 
 ## Comparison with the Stack v2
 In the table below one can find the comparsion between the Kotlin part of the Stack v2 and KStack:
-|              | Files | Repositories | Lines | Tokens |
-|--------------|:-----:|:------------:|:-----:|:------:|
-| The Stack v2 | 2M    | 109457       | 162M  | 1.7B   |
-| Kstack       | 4M    | 168902       | 292M  | 3.1B   |
+|                        | Files | Repositories | Lines | Tokens |
+|------------------------|:-----:|:------------:|:-----:|:------:|
+| Kotlin in The Stack v2 | 2M    | 109457       | 162M  | 1.7B   |
+| Kstack                 | 4M    | 168902       | 292M  | 3.1B   |
 
 # Dataset Creation
 
@@ -83,8 +66,7 @@ In the table below one can find the comparsion between the Kotlin part of the St
 We collected repositories from GitHub with the main language being Kotlin, as well as any repositories with Kotlin files that have received 10 or more stars (as of February 2024). Additionally, we gathered repositories with Kotlin files from Stack v1.2. Kotlin files were identified using [go-enry](https://github.com/go-enry/go-enry) and include files with extensions such as `.kt`, `.kts`, and `.gradle.kts`. It is estimated that we have collected 97% of available Kotlin repositories as of February 2024.
 
 ## Initial filtering
-We conducted full deduplication, using the hash of file content, as well as near deduplication using the same method as in [Stack v1.2](https://arxiv.org/pdf/2211.15533). We then aggregated the files from one near-deduplicated cluster into a single file from that cluster.
-
+We conducted full deduplication, using the hash of file content, as well as near deduplication using the same method as in [Stack v1.2](https://arxiv.org/pdf/2211.15533). We aggregated the files from one near-deduplicated cluster into a file from the repository with the most stars.
 ## Detecting permissive licenses
 We filtered permissive repositories based on the licenses detected by GitHub, and using [go-license-detector](https://github.com/src-d/go-license-detector) if GitHub did not have licensing information available. 
 The list of permissive licenses used in dataset can be found [here](https://huggingface.co/datasets/JetBrains/KStack/blob/main/licenses.json).
@@ -92,5 +74,23 @@ The list of permissive licenses used in dataset can be found [here](https://hugg
 ## Personal and Sensitive Information
 To filter personal information, we applied the same model that used for Stack v2. -- the [star-pii](https://arxiv.org/abs/2402.19173). 
 
-## Opt-out
+# Column description
+The dataset contains the following columns: 
+
+ - `size` — size of the file in bytes  
+ - `content` — text (content) of the file after removing personal identifiable information
+ - `repo_id` — GitHub ID of the repository  
+ - `path` — path to a file  
+ - `owner` — repo owner on GitHub  
+ - `name` — repo name on GitHub  
+ - `commit_sha` — hash of the commit, from which the revision of the file is taken  
+ - `stars` — number of stars in the repo at the moment of collection  
+ - `forks` — number of forks in the repo at the moment of collection  
+ - `issues` — number of issues in the repo at the moment of collection  
+ - `is_fork` — `true` if the repo is a fork or not as defined by GitHub
+ - `main_language` — main language of the repo as defined by GitHub  
+ - `languages_distribution` — JSON with the distribution of languages by size in bytes in the repo
+ - `license` — permissive license of the repository
+
+# Opt-out
 If you want your data to be removed from dataset, or have any other questions, please reach out to Sergey Titov: <[email protected]>