From deb7dd5d7b2efc73945cc6c81be86ec07ab930be Mon Sep 17 00:00:00 2001 From: Asahi Ushio Date: Tue, 2 Mar 2021 23:23:06 +0000 Subject: [PATCH 1/5] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6737840..bafd44a 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,11 @@

+ ***T-NER*** is a python tool for language model finetuning on named-entity-recognition (NER), available via [pip](https://pypi.org/project/tner/). It has an easy interface to finetune models and test on cross-domain and multilingual datasets. TNER currently integrates 9 publicly available NER datasets an enables an easy integration of custom datasets. -All models finetuned with TNER can be deploy on our web app for visualization. +All models finetuned with T-NER can be deploy on our web app for visualization. +Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Paper link is [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf). ***PreTrained Models Release:*** We release 46 XLM-RoBERTa models finetuned on NER on the HuggingFace transformers model hub, [see here for more details and model cards](https://github.com/asahi417/tner/blob/master/MODEL_CARD.md). @@ -22,6 +24,7 @@ All models finetuned with TNER can be deploy on our web app for visualization. 5. **[Model Evaluation](#model-evaluation)** [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1jHVGnFN4AU8uS-ozWJIXXe2fV8HUj8NZ?usp=sharing) 6. **[Model Inference](#model-inference)** [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1mQ_kQWeZkVs6LgV0KawHxHckFraYcFfO?usp=sharing) 7. **[Datasets](#datasets)** +8. **[Reference](#reference-paper)** ## Get Started Install pip package @@ -182,3 +185,12 @@ first word of the second entity will be tagged B-XXX in order to show that it st The custom dataset should have `train.txt` and `valid.txt` files in a same folder. Please take a look [sample custom data](https://github.com/asahi417/tner/tree/master/examples/custom_dataset_sample). + +## Reference paper +If you use any of these resources, please cite the following paper: + +@InProceedings{ushio2021tner, + author = "Asahi, Ushio and Camacho-Collados, Jose", + title = "T-NER: An All-Round Python Library for Transformer-based Named Entity Recognition", + booktitle = "Proceedings of EACL: System Demonstrations", + year = "2021",} From 693396111ae62dca786bba590da7c91bc9682448 Mon Sep 17 00:00:00 2001 From: Asahi Ushio Date: Tue, 2 Mar 2021 23:25:28 +0000 Subject: [PATCH 2/5] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bafd44a..be7bf13 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ ***T-NER*** is a python tool for language model finetuning on named-entity-recognition (NER), available via [pip](https://pypi.org/project/tner/). It has an easy interface to finetune models and test on cross-domain and multilingual datasets. TNER currently integrates 9 publicly available NER datasets an enables an easy integration of custom datasets. All models finetuned with T-NER can be deploy on our web app for visualization. -Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Paper link is [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf). -***PreTrained Models Release:*** We release 46 XLM-RoBERTa models finetuned on NER on the HuggingFace transformers model hub, [see here for more details and model cards](https://github.com/asahi417/tner/blob/master/MODEL_CARD.md). +**Paper Accepted:** Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Please find our preprint [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf)! + +***PreTrained Models:*** We release 46 XLM-RoBERTa models finetuned on NER on the HuggingFace transformers model hub, [see here for more details and model cards](https://github.com/asahi417/tner/blob/master/MODEL_CARD.md). ### Table of Contents 1. **[Setup](#get-started)** From d44a0f50eb4a7785dbcaea5a838b8d8d858d89c8 Mon Sep 17 00:00:00 2001 From: Asahi Ushio Date: Tue, 2 Mar 2021 23:25:44 +0000 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be7bf13..1baae95 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ It has an easy interface to finetune models and test on cross-domain and multilingual datasets. TNER currently integrates 9 publicly available NER datasets an enables an easy integration of custom datasets. All models finetuned with T-NER can be deploy on our web app for visualization. -**Paper Accepted:** Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Please find our preprint [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf)! +***Paper Accepted:*** Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Please find our preprint [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf)! ***PreTrained Models:*** We release 46 XLM-RoBERTa models finetuned on NER on the HuggingFace transformers model hub, [see here for more details and model cards](https://github.com/asahi417/tner/blob/master/MODEL_CARD.md). From 38095763672918b1dfbc58e0fa6b3c74e2346ca5 Mon Sep 17 00:00:00 2001 From: Asahi Ushio Date: Tue, 2 Mar 2021 23:26:31 +0000 Subject: [PATCH 4/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1baae95..7d162b4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ It has an easy interface to finetune models and test on cross-domain and multilingual datasets. TNER currently integrates 9 publicly available NER datasets an enables an easy integration of custom datasets. All models finetuned with T-NER can be deploy on our web app for visualization. -***Paper Accepted:*** Our paper demonstrating T-NER has been accepted EACL 2021 🎉 Please find our preprint [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf)! +***Paper Accepted:*** Our paper demonstrating T-NER has been accepted EACL 2021 🎉 +Please find our preprint [here](https://github.com/asahi417/tner/blob/master/asset/2021_01_EACL_TNER.pdf)! ***PreTrained Models:*** We release 46 XLM-RoBERTa models finetuned on NER on the HuggingFace transformers model hub, [see here for more details and model cards](https://github.com/asahi417/tner/blob/master/MODEL_CARD.md). From 195344e7a59adce4744bc7fed8530953a3863e6a Mon Sep 17 00:00:00 2001 From: Asahi Ushio Date: Tue, 2 Mar 2021 23:27:09 +0000 Subject: [PATCH 5/5] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d162b4..f0c32b8 100644 --- a/README.md +++ b/README.md @@ -190,9 +190,11 @@ Please take a look [sample custom data](https://github.com/asahi417/tner/tree/ma ## Reference paper If you use any of these resources, please cite the following paper: - +``` @InProceedings{ushio2021tner, author = "Asahi, Ushio and Camacho-Collados, Jose", title = "T-NER: An All-Round Python Library for Transformer-based Named Entity Recognition", booktitle = "Proceedings of EACL: System Demonstrations", - year = "2021",} + year = "2021" + } +```