Update README.md
Browse files
README.md
CHANGED
|
@@ -12,4 +12,55 @@ size_categories:
|
|
| 12 |
# Overview
|
| 13 |
|
| 14 |
This dataset contains 18,219 rows of code-docstring-ast data along with additional metadata. Data was gathered from various Python libraries and frameworks
|
| 15 |
-
publicly available GitHub repos.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
# Overview
|
| 13 |
|
| 14 |
This dataset contains 18,219 rows of code-docstring-ast data along with additional metadata. Data was gathered from various Python libraries and frameworks
|
| 15 |
+
publicly available GitHub repos. Initial raw dataset count was 25,480 down to 18,219 after preprocessing.
|
| 16 |
+
|
| 17 |
+
# Sources
|
| 18 |
+
|
| 19 |
+
The dataset was gathered from various GitHub repos sampled from [this repo by Vinta.](https://github.com/vinta/awesome-python)
|
| 20 |
+
|
| 21 |
+
The 26 repos are:
|
| 22 |
+
- matplotlib
|
| 23 |
+
- pytorch
|
| 24 |
+
- cryptography
|
| 25 |
+
- django
|
| 26 |
+
- prospector
|
| 27 |
+
- scikit-learn
|
| 28 |
+
- pandas
|
| 29 |
+
- numpy
|
| 30 |
+
- uvicorn
|
| 31 |
+
- feincms
|
| 32 |
+
- algorithms
|
| 33 |
+
- scrapy
|
| 34 |
+
- authlib
|
| 35 |
+
- seaborn
|
| 36 |
+
- coconut
|
| 37 |
+
- tensorflow
|
| 38 |
+
- flexx
|
| 39 |
+
- salmon
|
| 40 |
+
- mongo-python-driver
|
| 41 |
+
- virtualenv
|
| 42 |
+
- sphinx
|
| 43 |
+
- schema
|
| 44 |
+
- kornia
|
| 45 |
+
- scipy
|
| 46 |
+
- cherrypy
|
| 47 |
+
- pygame
|
| 48 |
+
|
| 49 |
+
Sampling was at random; I simply browsed through each category from Vinta's list and chose one from a random interesting category.
|
| 50 |
+
|
| 51 |
+
# Dataset Instance
|
| 52 |
+
|
| 53 |
+
An instance of the dataset is as follows:
|
| 54 |
+
|
| 55 |
+
```
|
| 56 |
+
{
|
| 57 |
+
<library> : <The library from which the source code came from>,
|
| 58 |
+
<name> : <The name of the function/class/method>,
|
| 59 |
+
<source code> : <The raw source code itself>,
|
| 60 |
+
<docstring> : <The corresponding docstring of the code>,
|
| 61 |
+
<type> : <Whether it's a function, method, or class>,
|
| 62 |
+
<file_path> : <The relative path of the file containing the function>,
|
| 63 |
+
<line_number> : <The line number of the function, method, or class within the file>,
|
| 64 |
+
<ast_sequence> : <The ast sequence of the raw source code. Scroll down for more info about this>
|
| 65 |
+
}
|
| 66 |
+
```
|