mvasiliniuc commited on
Commit
1534057
1 Parent(s): c9901b1

Create initial README.md

Browse files

Change contains:
* Addition of initial tags and metadata fields
* Addition of skeleton for description
* Full readme content to be provided later

Type: Project Setup

Files changed (1) hide show
  1. README.md +66 -0
README.md ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ annotations_creators: []
3
+ license: other
4
+ language_creators:
5
+ - crowdsourced
6
+ language:
7
+ - code
8
+ task_categories:
9
+ - text-generation
10
+ tags:
11
+ - code
12
+ size_categories:
13
+ - unknown
14
+ source_datasets: []
15
+ pretty_name: iva-swift-raw
16
+ task_ids:
17
+ - language-modeling
18
+ ---
19
+
20
+ # GitHub Swift Code Dataset
21
+
22
+ ## Dataset Description
23
+ Soon...
24
+
25
+ ### How to use it
26
+ Soon...
27
+
28
+ ## Data Structure
29
+ Soon...
30
+
31
+ ### Data Fields
32
+
33
+ |Field|Type|Description|
34
+ |---|---|---|
35
+ |repo_name|string|name of the GitHub repository|
36
+ |path|string|path of file in GitHub repository|
37
+ |copies|string|number of occurrences in dataset|
38
+ |code|string|content of source file|
39
+ |size|int|size of source file in bytes|
40
+ |license|string|license of GitHub repository|
41
+
42
+ ## Languages
43
+
44
+ The dataset contains 30 programming languages with over 60 extensions:
45
+
46
+ ```python
47
+ {
48
+ "Swift": [".swift"]
49
+ }
50
+ ```
51
+
52
+ ## Licenses
53
+ Soon...
54
+
55
+ ## Dataset Statistics
56
+ Soon...
57
+
58
+ ## Dataset Creation
59
+
60
+ The dataset was created in the following steps:
61
+ 1. Files of with the extensions given in the list above were retrieved from the GitHub dataset on BigQuery. TODO: Link to query and date.
62
+ 2. TODO: Add curating steps
63
+
64
+ ## Considerations for Using the Data
65
+
66
+ The dataset consists of source code from a wide range of repositories. As such they can potentially include harmful or biased code as well as sensitive information like passwords or usernames.