Update README.md

README.md

@@ -50,25 +50,25 @@ configs:
 # Dataset Summary
 KStack is the largest collection of permissively licensed Kotlin code.
 ![banner](https://huggingface.co/datasets/JetBrains/KStack/resolve/main/banner.png)
-## Columns description
-The dataset contains following columns: 
+## Column description
+The dataset contains the following columns: 
 
- - `size` - size of file in bytes  
- - `content` - text (content) of the file after PII extraction  
- - `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 on the moment of collection  
- - `forks` - Number of forks in the repo on the moment of collection  
- - `issues` - Number of issues in the repo on the moment of collection  
- - `is_fork` - Flag if the repo is a fork or not by GitHub definition  
- - `main_language` - Main language of the repo defined by GitHub  
- - `languages_distribution` - JSON with the distribution of the files by size in bytes in the repo  
+ - `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  
 
 ## Comparison with the Stack v2
-In the table below one can find the comparsion of the between Kotlin part of the Stack v2 and KStack:
+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   |
@@ -77,17 +77,17 @@ In the table below one can find the comparsion of the between Kotlin part of the
 # Dataset Creation
 
 ## Collection procedure
-We collected repositories from GitHub with the main language being Kotlin, as well as 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.
+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.
 
 ## Detecting permissive licenses
-We filtered permissive repositories based on the licenses detected by GitHub, and using go-license-detector if GitHub did not have license information available. 
-The list of permissive licenses used in dataset could be found [here](https://huggingface.co/datasets/JetBrains/KStack/blob/main/licenses.json).
+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).
 
 ## Personal and Sensitive Information
-We used [star-pii](https://arxiv.org/abs/2402.19173) model to filter out personal info.
+We used the [star-pii](https://arxiv.org/abs/2402.19173) model to filter out personal information.
 
 ## 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]>