update readme

Author: HaoyeTianCoder

README.md

@@ -40,12 +40,13 @@ run.py: entrance to conduct experiment.
 
 ### B) Colleted elements
 ```
-data/BugReport: Bug reports for Defects4j, Bugsjar, Bears. Structured as `bug-id $$ bug report summary $$ bug report description`.
-data/CommitMessage: Commit messages written by developer or generated by CodeTrans. Structured as `bug-id: commit message` in json file.
+data/BugReport: Bug reports texts for Defects4j, Bugsjar, Bears. Structured as `bug-id $$ bug report summary $$ bug report description` in txt file.
+data/CommitMessage: Commit messages written by developer or generated by CodeTrans in format of json and pickle. Structured as `bug-id: commit message` in json file.
 ---------------
 BATS_RESULT_0.0.json: the prediction results of BATS with cut-off 0.0 on our dataset. 
 BATS_RESULT_0.8.json: the prediction results of BATS with cut-off 0.8 on our dataset.
 PATCHSIM_RESULT.json: the prediction results of Patch-Sim on our dataset.
+PatchLabelsYe.csv: the original prediction results of ODS.
 Bears_testinfo.txt: the stack failure information of test suites for Bears.   
 bears_index_dict(inverse).json: dictionary of bug-id and commit-id. 
 save_bugreport_patch.py: script to produce data/bugreport_patch.txt.

data/README.md

@@ -3,10 +3,20 @@
   2. bug report description: detailed description for bug issue.
   3. patch description: CodeTrans-generated commit message for patch.
 
-### Table 1: Datasets of labelled patches.
+### A) Table 1: Datasets of labelled patches.
 * **bugreport_patch.txt:** 9135 (1591:7544) Pairs of Bug report & Commit message. Structured as `bug-id $$ bug report summary $$ bug report description $$ patchId $$ patch description $$ label`
 * **bugreport_patch_json_bert.pickle:** Bert embeddings of Pairs of Bug report & Commit message.
 
-### Colleted elements
-* **BugReport:** Bug reports for Defects4j, Bugsjar, Bears. Structured as `bug-id $$ bug report summary $$ bug report description`.
-* **CommitMessage:** Commit messages written by developer or generated by CodeTrans. Structured as `bug-id: commit message` in json file.
+### B) Colleted elements
+```
+data/BugReport: Bug reports texts for Defects4j, Bugsjar, Bears. Structured as `bug-id $$ bug report summary $$ bug report description` in txt file.
+data/CommitMessage: Commit messages written by developer or generated by CodeTrans in format of json and pickle. Structured as `bug-id: commit message` in json file.
+---------------
+BATS_RESULT_0.0.json: the prediction results of BATS with cut-off 0.0 on our dataset. 
+BATS_RESULT_0.8.json: the prediction results of BATS with cut-off 0.8 on our dataset.
+PATCHSIM_RESULT.json: the prediction results of Patch-Sim on our dataset.
+PatchLabelsYe.csv: the original prediction results of ODS.
+Bears_testinfo.txt: the stack failure information of test suites for Bears.   
+bears_index_dict(inverse).json: dictionary of bug-id and commit-id. 
+save_bugreport_patch.py: script to produce data/bugreport_patch.txt.
+```

preprocess/README.md

@@ -3,14 +3,3 @@
 2, split patch
 3, format folders
 4, get source target file
-
-## data_util.py
-functions:
-- def writetxt2csv( , ): transform file from text to csv
-- def Prepare_data( , , is_filter = Ture): Scan data and build vocabulary
-- Class ShoProcess(): Process bar function
-- def numbr(string): replace '-' to none
-- def filter_punc(sentence): remove punctuation
-- def word2index(word, diction): given a word, return its index
-- def index2word(index, diction): given an index, return its word
-- def splitdata( , ): split data and build dictionary