Update README.md

README.md

@@ -12,6 +12,68 @@ Bert4news is used for a toolkit Vietnames(segmentation and Named Entity Recognit
 
 **[BERT](https://github.com/google-research/bert)** (from Google Research and the Toyota Technological Institute at Chicago) released with the paper [BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding](https://arxiv.org/abs/1810.04805).
 
+
+# Vietnamese toolkit with bert
+ViNLP is a system annotation for Vietnamese, it use pretrain [Bert4news](https://github.com/bino282/bert4news/) to fine-turning to NLP problems in Vietnamese components of wordsegmentation,Named entity recognition (NER)  and achieve high accuravy.
+
+### Installation
+```bash
+git clone https://github.com/bino282/ViNLP.git
+cd ViNLP
+python setup.py develop build
+```
+
+### Test Segmentation
+The model achieved F1 score : 0.984 on VLSP 2013 dataset
+
+|Model | F1 |
+|--------|-----------|
+| **BertVnTokenizer** | 98.40 |
+| **DongDu** | 96.90 |
+| **JvnSegmenter-Maxent** | 97.00 |
+| **JvnSegmenter-CRFs** | 97.06 |
+| **VnTokenizer** | 97.33 |
+| **UETSegmenter** | 97.87 |
+| **VnTokenizer** | 97.33 |
+| **VnCoreNLP (i.e. RDRsegmenter)** | 97.90 |
+
+
+``` bash
+from ViNLP import BertVnTokenizer
+tokenizer = BertVnTokenizer()
+sentences = tokenizer.split(["Tổng thống Donald Trump ký sắc lệnh cấm mọi giao dịch của Mỹ với ByteDance và Tecent - chủ sở hữu của 2 ứng dụng phổ biến TikTok và WeChat sau 45 ngày nữa."])
+print(sentences[0])
+```
+``` bash
+Tổng_thống Donald_Trump ký sắc_lệnh cấm mọi giao_dịch của Mỹ với ByteDance và Tecent - chủ_sở_hữu của 2 ứng_dụng phổ_biến TikTok và WeChat sau 45 ngày nữa .
+
+```
+
+### Test Named Entity Recognition
+The model achieved F1 score VLSP 2018 for all named entities including nested entities : 0.786
+
+|Model | F1 |
+|--------|-----------|
+| **BertVnNer** | 78.60 |
+| **VNER Attentive Neural Network** | 77.52 |
+| **vietner CRF (ngrams + word shapes + cluster + w2v)** | 76.63 |
+| **ZA-NER BiLSTM** | 74.70 |
+
+``` bash
+from ViNLP import BertVnNer
+bert_ner_model = BertVnNer()
+sentence = "Theo SCMP, báo cáo của CSIS với tên gọi Định hình Tương lai Chính sách của Mỹ với Trung Quốc cũng cho thấy sự ủng hộ tương đối rộng rãi của các chuyên gia về việc cấm Huawei, tập đoàn viễn thông khổng lồ của Trung Quốc"
+entities = bert_ner_model.annotate([sentence])
+print(entities)
+
+```
+``` bash
+[{'ORGANIZATION': ['SCMP', 'CSIS', 'Huawei'], 'LOCATION': ['Mỹ', 'Trung Quốc']}]
+
+```
+
+
+
 We use word sentencepiece, use basic bert tokenization and same config with bert base with lowercase = False.
 
 You can download trained model: