sbmaruf commited on
Commit
f09b778
1 Parent(s): 8dbdf4b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -5
README.md CHANGED
@@ -37,9 +37,6 @@ task_categories:
37
  ---
38
 
39
 
40
-
41
- **NOTE**: Please ignore the Dataset Preview.
42
-
43
  [github](https://github.com/ntunlp/xCodeEval)
44
 
45
  # xCodeEval
@@ -51,11 +48,27 @@ This repository contains the sample code and data link for xCodeEval [paper](htt
51
 
52
  # Data Download
53
 
54
- Data is uploaded as a git LFS repo in huggingface.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
 
56
  ![xCodeEval_hf](https://github.com/ntunlp/xCodeEval/blob/main/xcodeeval.png?raw=true)
57
 
58
- You can download the full data using the following command. To Download the full dataset,
59
 
60
  ```
61
  GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/NTU-NLP-sg/xCodeEval
@@ -82,8 +95,11 @@ We propose 7 Tasks.
82
  6. [Code-Code Retrieval](https://github.com/ntunlp/xCodeEval/blob/main/retrieval.md)
83
  7. [NL-Code Retrieval](https://github.com/ntunlp/xCodeEval/blob/main/retrieval.md)
84
 
 
85
  # Common Data for different tasks
86
 
 
 
87
  ![xCodeEval_fig_1](https://github.com/ntunlp/xCodeEval/blob/main/xcodeeval_fig_1.png?raw=true)
88
 
89
  We have two data files that are required for multiple tasks.
 
37
  ---
38
 
39
 
 
 
 
40
  [github](https://github.com/ntunlp/xCodeEval)
41
 
42
  # xCodeEval
 
48
 
49
  # Data Download
50
 
51
+ Currently this repository supports huggingface [`load_dataset()`](https://huggingface.co/docs/datasets/v1.11.0/package_reference/loading_methods.html#datasets.load_dataset) api. Follow the following example to load dataset for individual examples.
52
+
53
+ ```
54
+ import datasets
55
+
56
+ prog_synthesis_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "program_synthesis")
57
+ code_translation_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "code_translation")
58
+ tag_classification_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "tag_classification")
59
+ apr_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "apr")
60
+ pcode_compilation_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "code_compilation")
61
+ retrieval_code_code_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "retrieval_code_code")
62
+ retrieval_nl_code_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "retrieval_nl_code")
63
+ retrieval_corpus_dataset = datasets.load_dataset("NTU-NLP-sg/xCodeEval", "retrieval_corpus")
64
+
65
+ ```
66
+
67
+ Data can be also downloaded as a git LFS repo from huggingface.
68
 
69
  ![xCodeEval_hf](https://github.com/ntunlp/xCodeEval/blob/main/xcodeeval.png?raw=true)
70
 
71
+ You can download the full data using the following command.
72
 
73
  ```
74
  GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/NTU-NLP-sg/xCodeEval
 
95
  6. [Code-Code Retrieval](https://github.com/ntunlp/xCodeEval/blob/main/retrieval.md)
96
  7. [NL-Code Retrieval](https://github.com/ntunlp/xCodeEval/blob/main/retrieval.md)
97
 
98
+
99
  # Common Data for different tasks
100
 
101
+ If you are not using huggingface [`load_dataset()`](https://huggingface.co/docs/datasets/v1.11.0/package_reference/loading_methods.html#datasets.load_dataset) api, you may need to link some data with different tasks.
102
+
103
  ![xCodeEval_fig_1](https://github.com/ntunlp/xCodeEval/blob/main/xcodeeval_fig_1.png?raw=true)
104
 
105
  We have two data files that are required for multiple tasks.