notional commited on
Commit
740fdbb
1 Parent(s): 71f52bc

Add README.md

Browse files

Provide dataset card containing information of the dataset.

Files changed (1) hide show
  1. README.md +144 -0
README.md ADDED
@@ -0,0 +1,144 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ annotations_creators:
2
+ - no-annotation
3
+ languages:
4
+ - py
5
+ language_creators:
6
+ - found
7
+ licenses:
8
+ - unknown
9
+ multilinguality:
10
+ - monolingual
11
+ size_categories:
12
+ - 10K<n<100K
13
+ source_datasets:
14
+ - original
15
+ task_categories:
16
+ - code-generation
17
+ - conditional-text-generation
18
+ task_ids:
19
+ - language-modeling
20
+ - code-generation
21
+
22
+
23
+ # Dataset Card for notional-python
24
+
25
+ ## Table of Contents
26
+ - [Dataset Description](#dataset-description)
27
+ - [Dataset Summary](#dataset-summary)
28
+ - [Supported Tasks](#supported-tasks-and-leaderboards)
29
+ - [Languages](#languages)
30
+ - [Dataset Structure](#dataset-structure)
31
+ - [Data Instances](#data-instances)
32
+ - [Data Fields](#data-instances)
33
+ - [Data Splits](#data-instances)
34
+ - [Dataset Creation](#dataset-creation)
35
+ - [Curation Rationale](#curation-rationale)
36
+ - [Source Data](#source-data)
37
+ - [Annotations](#annotations)
38
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
39
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
40
+ - [Social Impact of Dataset](#social-impact-of-dataset)
41
+ - [Discussion of Biases](#discussion-of-biases)
42
+ - [Other Known Limitations](#other-known-limitations)
43
+ - [Additional Information](#additional-information)
44
+ - [Dataset Curators](#dataset-curators)
45
+ - [Licensing Information](#licensing-information)
46
+ - [Citation Information](#citation-information)
47
+
48
+ ## Dataset Description
49
+
50
+ - **Homepage:** https://notional.ai/
51
+ - **Repository:** [Needs More Information]
52
+ - **Paper:** [Needs More Information]
53
+ - **Leaderboard:** [Needs More Information]
54
+ - **Point of Contact:** [Needs More Information]
55
+
56
+ ### Dataset Summary
57
+
58
+ The Notional-python dataset contains python code files from 100 well-known repositories gathered from Google Bigquery Github Dataset. The dataset was created to test the ability of programming language models.
59
+ Follow [our repo]() to do the model evaluation using notional-python dataset.
60
+
61
+ ### Supported Tasks and Leaderboards
62
+
63
+ [Needs More Information]
64
+
65
+ ### Languages
66
+
67
+ Python
68
+
69
+ ## Dataset Structure
70
+
71
+ ### Data Instances
72
+
73
+ [Needs More Information]
74
+
75
+ ### Data Fields
76
+
77
+ [Needs More Information]
78
+
79
+ ### Data Splits
80
+
81
+ [Needs More Information]
82
+
83
+ ## Dataset Creation
84
+
85
+ ### Curation Rationale
86
+
87
+ Notional-python was built to provide a dataset for testing the ability of the machine to generate python code.
88
+
89
+ ### Source Data
90
+
91
+ #### Initial Data Collection and Normalization
92
+
93
+ The data was obtained by filtering code from [Google Bigquery Github data](https://cloud.google.com/blog/topics/public-datasets/github-on-bigquery-analyze-all-the-open-source-code)
94
+ In order to improve the quality of the dataset, only python code files that meet the below conditions are added to the dataset:
95
+ - Code with more than 60% of executable lines
96
+ - Code with logic, not config files or comment-only files
97
+ - Code with more than 30% of attribute declaration lines (E.G.: Some files contain just only class names and their class attributes, usually used for configuration of the project, these files were not selected)
98
+ - Code without `TODO` and `FIXME`.
99
+
100
+ #### Who are the source language producers?
101
+
102
+ The producers are users of github.
103
+
104
+ ### Annotations
105
+
106
+ #### Annotation process
107
+
108
+ [Needs More Information]
109
+
110
+ #### Who are the annotators?
111
+
112
+ [Needs More Information]
113
+
114
+ ### Personal and Sensitive Information
115
+
116
+ [Needs More Information]
117
+
118
+ ## Considerations for Using the Data
119
+
120
+ ### Social Impact of Dataset
121
+
122
+ [Needs More Information]
123
+
124
+ ### Discussion of Biases
125
+
126
+ [Needs More Information]
127
+
128
+ ### Other Known Limitations
129
+
130
+ [Needs More Information]
131
+
132
+ ## Additional Information
133
+
134
+ ### Dataset Curators
135
+
136
+ [Needs More Information]
137
+
138
+ ### Licensing Information
139
+
140
+ [Needs More Information]
141
+
142
+ ### Citation Information
143
+
144
+ [Needs More Information]