Update README.md

README.md

@@ -1,9 +1,9 @@
 # GitHub Code Dataset
 
-## What is it?
+## Dataset Description
 The GitHub Code dataest consists of 115M code files from GitHub in 32 programming languages with 60 extensions totalling in 1TB of text data. The dataset was created from the public GitHub dataset on Google BiqQuery.
 
-## How to use it
+### How to use it
 
 The GitHub Code dataset is a very large dataset so for most use cases it is recommended to make use of the streaming API of `datasets`. You can load and iterate through the dataset with the following two lines of code:
 
@@ -61,6 +61,36 @@ Naturally, you can also download the full dataset. Note that this will download
 ds = load_dataset("lvwerra/github-code", split="train")
 ```
 
+## Data Structure
+
+### Data Instances
+
+```python
+{
+ 'code': "import mod189 from './mod189';\nvar value=mod189+1;\nexport default value;\n",
+ 'repo_name': 'MirekSz/webpack-es6-ts',
+ 'path': 'app/mods/mod190.js',
+ 'language': 'JavaScript',
+ 'license': 'isc',
+ 'size': 73
+}
+```
+
+### Data Fields
+
+|Field|Type|Description|
+|---|---|---|
+|code|string|content of source file|
+|repo_name|string|name of the GitHub repository|
+|path|string|path of file in GitHub repository|
+|language|string|programming language as inferred by extension|
+|license|string|license of GitHub repository|
+|size|int|size of source file in bytes|
+
+### Data Splits
+
+The dataset only contains a train split.
+
 ## Languages
 
 The dataset contains 30 programming languages with over 60 extensions:
@@ -122,8 +152,12 @@ Each example is also annotated with the license of the associated repository. Th
  ]
 ```
 
-## Dataset creation
+## Dataset Creation
 
 The dataset was created in two steps:
 1. Files of with the extensions given in the list above were retrieved from the GitHub dataset on BigQuery (full query [here](https://huggingface.co/datasets/lvwerra/github-code/blob/main/query.sql)). The query was executed on _Feb 14, 2022, 12:03:16 PM UTC+1_.
-2. Files with lines longer than 1000 characters and duplicates (exact duplicates ignoring whitespaces) were dropped (full preprocessing script [here](https://huggingface.co/datasets/lvwerra/github-code/blob/main/github_preprocessing.py)).
+2. Files with lines longer than 1000 characters and duplicates (exact duplicates ignoring whitespaces) were dropped (full preprocessing script [here](https://huggingface.co/datasets/lvwerra/github-code/blob/main/github_preprocessing.py)).
+
+## Considerations for Using the Data
+
+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.