Update README.md
Browse files
README.md
CHANGED
@@ -141,23 +141,24 @@ Data fields for function level:
|
|
141 |
|
142 |
- **repo** (string): the owner/repo
|
143 |
- **path** (string): the full path to the original file
|
144 |
-
- **license** (
|
145 |
- **language** (string): the programming language
|
146 |
- **identifier** (string): the function or method name
|
147 |
- **return_type** (string): the type returned by the function
|
148 |
- **original_string** (string): original version of function/class node
|
149 |
- **original_docstring** (string): the raw string before tokenization or parsing
|
150 |
- **code** (string): the part of the original that is code
|
151 |
-
- **code_tokens** (
|
152 |
- **short_docstring** (string): short, brief summarization (first line of the docstring)
|
153 |
-
- **short_docstring_tokens** (
|
154 |
- **docstring** (string): the top-level comment or docstring (docstring version without param’s doc, return, exception, etc)
|
155 |
-
- **docstring_tokens** tokenized version of docstring
|
156 |
-
- **comment** (
|
157 |
-
- **parameters** (
|
158 |
- **docstring_params** (dict): Dictionary of the parsed information from docstring
|
159 |
|
160 |
-
|
|
|
161 |
### Data Splits
|
162 |
|
163 |
In this repo, The Vault is divided into 5 subsets, where three training versions are split based on dataset size, and the remains are validation set and test set (20,000 samples in each). The statistic for each language is illustrated in the following section.
|
@@ -219,6 +220,8 @@ for sample in iter(data['train']):
|
|
219 |
print(sample)
|
220 |
```
|
221 |
|
|
|
|
|
222 |
## Additional information
|
223 |
### Licensing Information
|
224 |
[More information needed]
|
|
|
141 |
|
142 |
- **repo** (string): the owner/repo
|
143 |
- **path** (string): the full path to the original file
|
144 |
+
- **license** (list): license in the repo
|
145 |
- **language** (string): the programming language
|
146 |
- **identifier** (string): the function or method name
|
147 |
- **return_type** (string): the type returned by the function
|
148 |
- **original_string** (string): original version of function/class node
|
149 |
- **original_docstring** (string): the raw string before tokenization or parsing
|
150 |
- **code** (string): the part of the original that is code
|
151 |
+
- **code_tokens** (list): tokenized version of `code`
|
152 |
- **short_docstring** (string): short, brief summarization (first line of the docstring)
|
153 |
+
- **short_docstring_tokens** (list): tokenized version of `short_docstring
|
154 |
- **docstring** (string): the top-level comment or docstring (docstring version without param’s doc, return, exception, etc)
|
155 |
+
- **docstring_tokens** (list): tokenized version of docstring
|
156 |
+
- **comment** (list): list of comments (line) inside the function/class
|
157 |
+
- **parameters** (list): List of parameters and its type (type can be None)
|
158 |
- **docstring_params** (dict): Dictionary of the parsed information from docstring
|
159 |
|
160 |
+
See [here](https://github.com/FSoft-AI4Code/TheVault/blob/main/data/README.md) for more details and examples.
|
161 |
+
|
162 |
### Data Splits
|
163 |
|
164 |
In this repo, The Vault is divided into 5 subsets, where three training versions are split based on dataset size, and the remains are validation set and test set (20,000 samples in each). The statistic for each language is illustrated in the following section.
|
|
|
220 |
print(sample)
|
221 |
```
|
222 |
|
223 |
+
A back up dataset can be downloaded in azure storage. See [Download The Vault from Azure blob storage](https://github.com/FSoft-AI4Code/TheVault/blob/main/README.md#download-data-from-azure-blob-storage)
|
224 |
+
|
225 |
## Additional information
|
226 |
### Licensing Information
|
227 |
[More information needed]
|