Self-supervised NER (prototype)

This repository containes code for solving NER with self-supervised learning (SSL) alone avoiding supervised learning.

Post describing the second iteration of this method

Model performance on 11 datasets

### Additional links - [Test repository link](https://github.com/ajitrajasekharan/ner_test.git) used to test this approach - [Medium post describing the previous iteration of this method](https://towardsdatascience.com/unsupervised-ner-using-bert-2d7af5f90b8a) - To identify noun phrase spans, [Dat Quoc Nguyen's POS tagger/Dependency parser](https://github.com/datquocnguyen/jPTDP) is used. ### Installation _If the use case is to automatically detect all noun phrase spans in a sentence, then POS tagger needs to be installed. If we only require specific phrases of interest to us in a sentence to be tagged (e.g. colorectal cancer above), then POS tagger install is **not** required. In the first use case, 7 microservices (POS tagger is made up of two microservices) are started. In the second use, case 5 microservices are started._ ### Step 1. Installing and starting microservices common to both use cases Run ./setup.sh _this will install and load all 5 microservices. When done (assuming all goes well) it should display the output of a test query_ ### Step 2. Install POS service _**(this can be skipped if we only require specific phrases to be tagged)**_ Install POS service using [this link](https://github.com/ajitrajasekharan/JPTDP_wrapper.git) *Make sure to run **both** services in the install instructions* _Note POS service requires python 2.7 environment_ ### Revision notes for major updates July 2022 - Added the generation of bootstrap file. These component files can be edited to improve the bootstrap list. Every time the bootstrap list is updated, we need to run the clustering run.sh _(and choose option 6)_ in [bert_vector_clustering](https://github.com/ajitrajasekharan/bert_vector_clustering.git) to both magnify this list as well as generate entity signatures for each vocabulary term for use in NER. A labeled set of entity files with instructions is present [here](https://github.com/ajitrajasekharan/unsupervised_NER/tree/master/ner_labeling) 17 Jan 2022 - Ensemble service of NER with two models tested on 11 NER benchmarks as described in this [post.](https://ajitrajasekharan.github.io/2021/01/02/my-first-post.html) 17 Sept 2021 - This can now be run as a service. run_servers.sh - Simple Ensembling service added for combining results of multiple NER servers ## Second version usage notes - If the install runs into issess, we could start the services independantly to isolate problem. - First install descriptors [service](https://github.com/ajitrajasekharan/bert_descriptors.git). Confirm it works. Then install NER [service](https://github.com/ajitrajasekharan/unsupervised_NER.git). Do this for both models (bio and phi). Then test ensemble service. Ensemble is in the subdirectory _ensemble_ in the NER service. - Test sets to test the output of NER against 11 benchmarks are in [this repository](https://github.com/ajitrajasekharan/ner_test.git). - This repository can be used as a metric to test a pretrained model trained from scratch. We can give the model an F1-score just like we do fine tuned model. To do this, we need to convert human labels file _(e.g. bootstrap_entities.txt)_ into magnified entity vectors using this [repository](https://github.com/ajitrajasekharan/bert_vector_clustering.git). Just invoke run.sh and use the _subword neighbor clustering option_ . If we want to pick the initial terms to label - the creation of bootstrap_entities.txt itself, run the same tool, but just choose the _generate cluster_ option and adaptive clustering. This will yield about 4k cluster pivots. We can start labeling them and then create entity vectors. The entity vectors (e.g. labels.txt) can then be used with descriptor [service](https://github.com/ajitrajasekharan/bert_descriptors.git) to test model. If we are creating new entity types, then the entity map file needs to be updated accordingly to map subtypes to types, or just add new types. ### First Version Usage notes The unsupervised NER tool can be used in three ways. 1) to tag canned sentences (option 1) - $ python3 main_ner.py 1 2) To tag custom sentences present in a file (option 2) - $ python3 main_ner.py 2 sample_test.txt 3) To tag single entities in custom sentences present in a file (option 3) where the single entity is specified in a sentence in the format name:__ entity __ . Concrete example: Cats and Dogs:__ entity __ are pets where Dogs is the term to be tagged. Single or multiple words/phrases within a sentence can also be tagged. Example: Her hypophysitis:__ entity __ secondary to ipilimumab:__ entity __ was well managed with supplemental:__ entity__ hormones:__ entity __ - $ python main_NER.py 3 single_entity_test.txt ### License This repository is covered by MIT license. [The POS tagger/Dep parser that this service depends on is covered by a GPL license.](https://github.com/datquocnguyen/jPTDP/blob/master/License.txt)