Create README.md

README.md

@@ -0,0 +1,26 @@
+---
+tags:
+- python
+- code
+---
+
+# CodeParrot 🦜 Dataset Cleaned
+
+## What is it?
+
+A dataset of Python files from Github. This is the deduplicated version of the [codeparrot](https://huggingface.co/datasets/transformersbook/codeparrot).
+
+## Processing
+The original dataset contains a lot of duplicated and noisy data. Therefore, the dataset was cleaned with the following steps:
+- Deduplication 
+  - Remove exact matches
+- Filtering
+  - Average line length < 100
+  - Maximum line length < 1000
+  - Alpha numeric characters fraction > 0.25
+  - Remove auto-generated files (keyword search)
+  
+For more details see the preprocessing script in the transformers repository [here](https://github.com/huggingface/transformers/tree/master/examples/research_projects/codeparrot).
+
+## Splits
+The dataset is split in a [train](https://huggingface.co/datasets/lvwerra/codeparrot-clean-train) and [validation](https://huggingface.co/datasets/lvwerra/codeparrot-clean-valid) split used for training and evaluation.