phusroyal commited on
Commit
a2ddd22
1 Parent(s): d81520b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -1
README.md CHANGED
@@ -61,6 +61,24 @@ It is splitted into train, dev, and test set with following information:
61
  2. Dev set: 1,106 comments
62
  3. Test set: 1,106 comments
63
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
64
  ## Data Structure
65
  Here is our data folder structure!
66
  ```
@@ -101,7 +119,7 @@ Description:
101
  - **word**: Words in the sentence after the processing of tokenization using [VnCoreNLP](https://github.com/vncorenlp/VnCoreNLP) tokenizer
102
  - **tag**: The tag of the word. The tag is either B-T (beginning of a word), I-T (inside of a word), or O (outside of a word).
103
  - The train_BIO_Word and dev_BIO_Word file are used for training and validation for PhoBERT model, respectively.
104
- - The test_BIO_Word file is used for reference only. It is not used for testing the model. **Please use the test.csv file in the Testdata folder for testing the model.**
105
 
106
  ### Span Extraction-based version
107
  Description:
 
61
  2. Dev set: 1,106 comments
62
  3. Test set: 1,106 comments
63
 
64
+ ## Data Instance
65
+
66
+ An span extraction-based (see Data Structure for more details) example of 'test' looks as follows:
67
+ ```
68
+ {
69
+ "content": "Thối CC chỉ không ngửi đuợc thôi",
70
+ 'index_spans': "[0, 1, 2, 3, 5, 6]"
71
+ }
72
+ ```
73
+
74
+ An equence labeling-based (see Data Structure for more details) example of 'test' looks as follows:
75
+ ```
76
+ {
77
+ "content": "Thối CC chỉ không ngửi đuợc thôi",
78
+ 'index_spans': ["B-T", "I-T", "O", "O", "O", "O", "O"]
79
+ }
80
+ ```
81
+
82
  ## Data Structure
83
  Here is our data folder structure!
84
  ```
 
119
  - **word**: Words in the sentence after the processing of tokenization using [VnCoreNLP](https://github.com/vncorenlp/VnCoreNLP) tokenizer
120
  - **tag**: The tag of the word. The tag is either B-T (beginning of a word), I-T (inside of a word), or O (outside of a word).
121
  - The train_BIO_Word and dev_BIO_Word file are used for training and validation for PhoBERT model, respectively.
122
+ - The test_BIO_Word file is used for reference only. It is not used for testing the model. **Please use the test.csv file in the data/test folder for testing the model.**
123
 
124
  ### Span Extraction-based version
125
  Description: