NLU release notes

NLU Version 4.2.2

• support for Medical Summarizers

New Medical Summarizers:

• ‘en.summarize.clinical_jsl’
• ‘en.summarize.clinical_jsl_augmented’
• ‘en.summarize.biomedical_pubmed’
• ‘en.summarize.generic_jsl’
• ‘en.summarize.clinical_questions’
• ‘en.summarize.radiology’
• ‘en.summarize.clinical_guidelines_large’
• ‘en.summarize.clinical_laymen’

NLU Version 4.2.1

Bugfixes for saving and reloading pipelines on databricks

NLU Version 4.2.0

Support for Speech2Text, Images-Classification, Tabular Data, Zero-Shot-NER, via Wav2Vec2, Tapas, VIT , 4000+ New Models, 90+ Languages, in John Snow Labs NLU 4.2.0

We are incredibly excited to announce NLU 4.2.0 has been released with new 4000+ models in 90+ languages and support for new 8 Deep Learning Architectures. 4 new tasks are included for the very first time, Zero-Shot-NER, Automatic Speech Recognition, Image Classification and Table Question Answering powered by Wav2Vec 2.0, HuBERT, TAPAS, VIT, SWIN, Zero-Shot-NER.

Additionally, CamemBERT based architectures are available for Sequence and Token Classification powered by Spark-NLPs CamemBertForSequenceClassification and CamemBertForTokenClassification

Automatic Speech Recognition (ASR)

Demo Notebook Wav2Vec 2.0 and HuBERT enable ASR for the very first time in NLU. Wav2Vec2 is a transformer model for speech recognition that uses unsupervised pre-training on large amounts of unlabeled speech data to improve the accuracy of automatic speech recognition (ASR) systems. It is based on a self-supervised learning approach that learns to predict masked portions of speech signal, and has shown promising results in reducing the amount of labeled training data required for ASR tasks.

These Models are powered by Spark-NLP’s Wav2Vec2ForCTC Annotator

HuBERT models match or surpass the SOTA approaches for speech representation learning for speech recognition, generation, and compression. The Hidden-Unit BERT (HuBERT) approach was proposed for self-supervised speech representation learning, which utilizes an offline clustering step to provide aligned target labels for a BERT-like prediction loss.

These Models is powered by Spark-NLP’s HubertForCTC Annotator

Usage

You just need an audio-file on disk and pass the path to it or a folder of audio-files.

import nlu
# Let's download an audio file 
!wget https://s3.amazonaws.com/auxdata.johnsnowlabs.com/public/resources/en/audio/samples/wavs/ngm_12484_01067234848.wav
# Let's listen to it 
from IPython.display import Audio
FILE_PATH = "ngm_12484_01067234848.wav"
asr_df = nlu.load('en.speech2text.wav2vec2.v2_base_960h').predict('ngm_12484_01067234848.wav')
asr_df

To test out HuBERT you just need to update the parameter for load()

asr_df = nlu.load('en.speech2text.hubert').predict('ngm_12484_01067234848.wav')
asr_df

Image Classification

Demo Notebook

For the first time ever NLU introduces state-of-the-art image classifiers based on
VIT and Swin giving you access to hundreds of image classifiers for various domains.

Inspired by the Transformer scaling successes in NLP, the researchers experimented with applying a standard Transformer directly to images, with the fewest possible modifications. To do so, images are split into patches and the sequence of linear embeddings of these patches were provided as an input to a Transformer. Image patches were actually treated the same way as tokens (words) in an NLP application. Image classification models were trained in supervised fashion.

You can check Scale Vision Transformers (ViT) Beyond Hugging Face article to learn deeper how ViT works and how it is implemeted in Spark NLP. This is Powerd by Spark-NLP’s VitForImageClassification Annotator

Swin is a hierarchical Transformer whose representation is computed with Shifted windows. The shifted windowing scheme brings greater efficiency by limiting self-attention computation to non-overlapping local windows while also allowing for cross-window connection. This hierarchical architecture has the flexibility to model at various scales and has linear computational complexity with respect to image size. These qualities of Swin Transformer make it compatible with a broad range of vision tasks This is powerd by Spark-NLP’s Swin For Image Classification Swin Transformer: Hierarchical Vision Transformer using Shifted Windows by Ze Liu, Yutong Lin, Yue Cao, Han Hu, Yixuan Wei, Zheng Zhang, Stephen Lin, Baining Guo.

Usage:

# Download an image
os.system('wget https://raw.githubusercontent.com/JohnSnowLabs/nlu/release/4.2.0/tests/datasets/ocr/vit/ox.jpg') 
# Load VIT model and predict on image file
vit = nlu.load('en.classify_image.base_patch16_224').predict('ox.jpg')

Lets download a folder of images and predict on it

!wget -q https://s3.amazonaws.com/auxdata.johnsnowlabs.com/public/resources/en/images/images.zip
import shutil
shutil.unpack_archive("images.zip", "images", "zip")
! ls /content/images/images/

Once we have image data its easy to label it, we just pass the folder with images to nlu.predict() and NLU will return a pandas DF with one row per image detected

nlu.load('en.classify_image.base_patch16_224').predict('/content/images/images')

To use SWIN we just update the parameter to load()

load('en.classify_image.swin.tiny').predict('/content/images/images')

Visual Table Question Answering

TapasForQuestionAnswering can load TAPAS Models with a cell selection head and optional aggregation head on top for question-answering tasks on tables (linear layers on top of the hidden-states output to compute logits and optional logits_aggregation), e.g. for SQA, WTQ or WikiSQL-supervised tasks. TAPAS is a BERT-based model specifically designed (and pre-trained) for answering questions about tabular data.

Demo Notebook

Powered by TAPAS: Weakly Supervised Table Parsing via Pre-training

Usage:

First we need a pandas dataframe on for which we want to ask questions. The so called “context”

import pandas as pd 

context_df = pd.DataFrame({
    'name':['Donald Trump','Elon Musk'], 
    'money': ['$100,000,000','$20,000,000,000,000'], 
    'married': ['yes','no'], 
    'age' : ['75','55'] })
context_df

Then we create an array of questions

questions = [
    "Who earns less than 200,000,000?",
    "Who earns more than 200,000,000?",
    "Who earns 100,000,000?",
    "How much money has Donald Trump?",
    "Who is the youngest?",
]
questions

Now Combine the data, pass it to NLU and get answers for your questions

import nlu
# Now we combine both to a tuple and we are done! We can now pass this to the .predict() method
tapas_data  = (context_df, questions)
# Lets load a TAPAS QA model and predict on (context,question). 
# It will give us an aswer for every question in the questions array, based on the context in context_df
answers = nlu.load('en.answer_question.tapas.wtq.large_finetuned').predict(tapas_data)
answers

Zero-Shot NER

Demo Notebook Based on John Snow Labs Enterprise-NLP ZeroShotNerModel This architecture is based on RoBertaForQuestionAnswering. Zero shot models excel at generalization, meaning that the model can accurately predict entities in very different data sets without the need to fine tune the model or train from scratch for each different domain. Even though a model trained to solve a specific problem can achieve better accuracy than a zero-shot model in this specific task, it probably won’t be be useful in a different task. That is where zero-shot models shows its usefulness by being able to achieve good results in various domains.

Usage:

We just need to load the zero-shot NER model and configure a set of entity definitions.

import nlu 
# load zero-shot ner model
enterprise_zero_shot_ner = nlu.load('en.zero_shot.ner_roberta')

# Configure entity definitions
enterprise_zero_shot_ner['zero_shot_ner'].setEntityDefinitions(
    {
        "PROBLEM": [
            "What is the disease?",
            "What is his symptom?",
            "What is her disease?",
            "What is his disease?",
            "What is the problem?",
            "What does a patient suffer",
            "What was the reason that the patient is admitted to the clinic?",
        ],
        "DRUG": [
            "Which drug?",
            "Which is the drug?",
            "What is the drug?",
            "Which drug does he use?",
            "Which drug does she use?",
            "Which drug do I use?",
            "Which drug is prescribed for a symptom?",
        ],
        "ADMISSION_DATE": ["When did patient admitted to a clinic?"],
        "PATIENT_AGE": [
            "How old is the patient?",
            "What is the gae of the patient?",
        ],
    }
)

Then we can already use this pipeline to predict labels

# Predict entities
df = enterprise_zero_shot_ner.predict(
    [
        "The doctor pescribed Majezik for my severe headache.",
        "The patient was admitted to the hospital for his colon cancer.",
        "27 years old patient was admitted to clinic on Sep 1st by Dr."+
        "X for a right-sided pleural effusion for thoracentesis.",
    ]
)
df

New Notebooks

• Image Classification with VIT and Swin
• Zero-Shot-NER
• Table Question Answering with TAPAS
• Automatic Speech Recognition with Wav2Vec2 and HuBERT

New Models Overview

Supported Languages are: ab, am, ar, ba, bem, bg, bn, ca, co, cs, da, de, dv, el, en, es, et, eu, fa, fi, fon, fr, fy, ga, gam, gl, gu, ha, he, hi, hr, hu, id, ig, is, it, ja, jv, kin, kn, ko, kr, ku, ky, la, lg, lo, lt, lu, luo, lv, lwt, ml, mn, mr, ms, mt, nb, nl, no, pcm, pl, pt, ro, ru, rw, sg, si, sk, sl, sq, st, su, sv, sw, swa, ta, te, th, ti, tl, tn, tr, tt, tw, uk, unk, ur, uz, vi, wo, xx, yo, yue, zh, zu

Automatic Speech Recognition Models Overview

Image Classification Models Overview

NLU Version 4.1.0

Approximately 1000 new state-of-the-art transformer models for Question Answering (QA) for over 10 languages, up to 700% speedup on GPU, 100+ Embeddings such as Bert, Bert Sentence, CamemBert, DistilBert, Roberta, Roberta Sentence, Universal Sentence Encoder, Word, XLM Roberta, XLM Roberta Sentence, 40 sequence classification models, +400 token classification odels for over 10 languages various Spark NLP helper methods and much more in 1 line of code with John Snow Labs NLU 4.1.0

NLU 4.1.0 Core Overview

• On the NLU core side we have over 1000 new state-of-the-art models in over 10 languages.

• Additionally up to 700% speedup transformer-based Word Embeddings on GPU and up to 97% speedup on CPU for tensorflow operations, support for Apple M1 chips, Pyspark 3.2 and 3.3 support. Ontop of this, we are now supporting Apple M1 based architectures and every Pyspark 3.X version, while deprecating support for Pyspark 2.X.

• Finally, NLU-Core features various new helper methods for working with Spark NLP and embellishes now the entire universe of Annotators defined by Spark NLP.

NLU captures every Annotator of Spark NLP

The entire universe of Annotators in Spark NLP is now embellished by NLU Components by using generalizable annotation extractors methods and configs internally to support enable the new NLU util methods. The following annotator classes are newly captured:

• BertEmbeddings
• BertForQuestionAnswering
• BertForSequenceClassification
• BertForTokenClassification
• BertSentenceEmbeddings
• CamemBertEmbeddings
• ClassifierDLModel
• ContextSpellCheckerModel
• DistilBertEmbeddings
• DistilBertForSequenceClassification
• DistilBertForTokenClassification
• LemmatizerModel
• LongformerForTokenClassification
• NerCrfModel
• NerDLModel
• PerceptronModel
• RoBertaEmbeddings
• RoBertaForQuestionAnswering
• RoBertaForSequenceClassification
• RoBertaForTokenClassification
• RoBertaSentenceEmbeddings
• SentenceDetectorDLModel
• StopWordsCleaner
• T5Transformer
• UniversalSentenceEncoder
• WordEmbeddingsModel
• XlmRoBertaEmbeddings
• XlmRoBertaForTokenClassification
• XlmRoBertaSentenceEmbeddings

Embeddings

Embeddings provides dense vector representations for natural language by using a deep, pre-trained neural network with the Transformer architecture. On the NLU core side we have over 150 new embeddings models. We have new BertEmbeddings, BertSentenceEmbeddings, CamemBertEmbeddings, DistilBertEmbeddings, RoBertaEmbeddings, UniversalSentenceEncoder, XlmRoBertaEmbeddings, XlmRoBertaSentenceEmbeddings for in different languages.

• German BertEmbeddings

nlu.load("de.embed.electra.base").predict("""Ich liebe Spark NLP""")

• English BertEmbeddings

text = ["I love NLP"]
df = nlu.load('en.embed_sentence.bert.pubmed').predict(text, output_level='token')
df

• Japan BertEmbeddings

nlu.load("ja.embed.bert.base").predict("""私はSpark NLPを愛しています""")

• XLM RoBerta Embeddings MultiLanguage

text = ["I love NLP", "Me encanta usar SparkNLP"]
embeddings_df = nlu.load('xx.embed.xlmr_roberta.base_v2').predict(text, output_level='sentence')
embeddings_df

• RoBerta Embeddings English

text = ["""I love Spark NLP"""]
embeddings_df = nlu.load('en.embed.roberta').predict(text, output_level='token')
embeddings_df

Question Answering

Question Answering models can retrieve the answer to a question from a given text, which is useful for searching for an answer in a document. On the NLU core side we have over 200+ new question answering models.

• Bert For Question Answering

nlu.load("answer_question.bert.base_uncased.by_ksabeh").predict("""What is my name?|||"My name is Clara and I live in Berkeley.""")

Sequence Classification

Sequence classification is the task of predicting a class label given a sequence of observations. On the NLU core side we have over 40 new sequence classification models.

• Bert For Sequence Classification

nlu.load("classify.bert.by_mrm8488").predict("""Camera - You are awarded a SiPix Digital Camera! call 09061221066 from landline. Delivery within 28 days.""")

• DistilBert For Sequence Classification

nlu.load("de.classify.distil_bert.base").predict("Natürlich kann ich von zuwanderern mehr erwarten. muss ich sogar. sie müssen die sprache lernen, sie müssen die gepflogenheiten lernen und sich in die gesellschaft einfügen. dass muss ich nicht weil ich mich schon in die gesellschaft eingefügt habe. egal wo du hin ziehst, nirgendwo wird dir soviel zucker in den arsch geblasen wie in deutschland.")

• RoBerta For Sequence Classification

nlu.load("en.classify.roberta.finetuned").predict("I love you very much!")

Lemmatizer

Lemmatization in linguistics is the process of grouping together the inflected forms of a word so they can be analysed as a single item, identified by the word’s lemma, or dictionary form. On the NLU core side we have over 30 new lemmatizer models.

ClassifierDLModel

ClassifierDL for generic Multi-class Text Classification. ClassifierDL uses the state-of-the-art Universal Sentence Encoder as an input for text classifications. The ClassifierDL annotator uses a deep learning model (DNNs) we have built inside TensorFlow and supports up to 100 classes. On the NLU core side we have over 5 new ClassifierDLModel models.

ContextSpellCheckerModel

Spell Checking is a sequence to sequence mapping problem. Given an input sequence, potentially containing a certain number of errors, ContextSpellChecker will rank correction sequences according to three things:

1. Different correction candidates for each word — word level.
2. The surrounding text of each word, i.e. it’s context — sentence level.
3. The relative cost of different correction candidates according to the edit operations at the character level it requires — subword level.

On the NLU core side we have over 5 new ClassifierDLModel models.

Token Classification

Token classification is a natural language understanding task in which a label is assigned to some tokens in a text. Some popular token classification subtasks are Named Entity Recognition (NER) and Part-of-Speech (PoS) tagging. NER models could be trained to identify specific entities in a text, such as dates, individuals and places; and PoS tagging would identify, for example, which words in a text are verbs, nouns, and punctuation marks. We have new 463 models XlmRoBertaForTokenClassification, BertForTokenClassification, DistilBertForTokenClassification, DistilBertEmbeddings, LongformerForTokenClassification, RoBertaForTokenClassification for in different languages.

• BertForTokenClassification English

nlu.load("en.ner.bc5cdr.biobert.disease").predict("I love you very much!")

• BertForTokenClassification German

nlu.load("de.ner.distil_bert.base_cased").predict("Ich liebe Spark NLP")

• XlmRoBertaForTokenClassification Igbo

nlu.load("ig.ner.xlmr_roberta.base").predict("Ahụrụ m n'anya na-atọ m ụtọ")

NerCrfModel

This Named Entity Recognizer is based on a CRF Algorithm. Conditional random fields (CRFs) are a class of statistical modeling methods often applied in pattern recognition and machine learning and used for structured prediction. Whereas a classifier predicts a label for a single sample without considering “neighbouring” samples, a CRF can take context into account. To do so, the predictions are modelled as a graphical model, which represents the presence of dependencies between the predictions. What kind of graph is used depends on the application. For example, in natural language processing, “linear chain” CRFs are popular, for which each prediction is dependent only on its immediate neighbours. In image processing, the graph typically connects locations to nearby and/or similar locations to enforce that they receive similar predictions.

• NerCrfModel

nlu.load('en.ner.ner.crf').predict("Donald Trump and Angela Merkel dont share many oppinions")

NerDLModel

This Named Entity recognition annotator is a generic NER model based on Neural Networks. Neural Network architecture is Char CNNs - BiLSTM - CRF that achieves state-of-the-art in most datasets. This is the instantiated model of the NerDLApproach. For training your own model, please see the documentation of that class. We have new 6 models.

• NerDLModel Japanese

nlu.load('ja.ner.ner.base').predict("宮本茂氏は、日本の任天堂のゲームプロデューサーです。")

• NerDLModel English

text = ["My name is John!"]

nlu.load('en.ner.conll.ner.large').predict(text, output_level='token')

PerceptronModel

We have new 26 models.

StopWordsCleaner

This model removes ‘stop words’ from text. Stop words are words so common that they can be removed without significantly altering the meaning of a text. Removing stop words is useful when one wants to deal with only the most semantically important words in a text, and ignore words that are rarely semantically relevant, such as articles and prepositions. We have new 33 models.

NLU Version 4.0.0

OCR Visual Tables into Pandas DataFrames from PDF/DOC(X)/PPT files, 1000+ new state-of-the-art transformer models for Question Answering (QA) for over 30 languages, up to 700% speedup on GPU, 20 Biomedical models for over 8 languages, 50+ Terminology Code Mappers between RXNORM, NDC, UMLS,ICD10, ICDO, UMLS, SNOMED and MESH, Deidentification in Romanian, various Spark NLP helper methods and much more in 1 line of code with John Snow Labs NLU 4.0.0

NLU 4.0 for OCR Overview

On the OCR side, we now support extracting tables from PDF/DOC(X)/PPT files into structured pandas dataframe, making it easier than ever before to analyze bulks of files visually!

Checkout the OCR Tutorial for extracting Tables from Image/PDF/DOC(X) files to see this in action

These models grab all Table data from the files detected and return a list of Pandas DataFrames,
containing Pandas DataFrame for every table detected

This is powerd by John Snow Labs Spark OCR Annotataors for PdfToTextTable, DocToTextTable, PptToTextTable

NLU 4.0 Core Overview

• On the NLU core side we have over 1000+ new state-of-the-art models in over 30 languages for modern extractive transformer-based Question Answering problems powerd by the ALBERT/BERT/DistilBERT/DeBERTa/RoBERTa/Longformer Spark NLP Annotators trained on various SQUAD-like QA datasets for domains like Twitter, Tech, News, Biomedical COVID-19 and in various model subflavors like sci_bert, electra, mini_lm, covid_bert, bio_bert, indo_bert, muril, sapbert, bioformer, link_bert, mac_bert

• Additionally up to 700% speedup transformer-based Word Embeddings on GPU and up to 97% speedup on CPU for tensorflow operations, support for Apple M1 chips, Pyspark 3.2 and 3.3 support. Ontop of this, we are now supporting Apple M1 based architectures and every Pyspark 3.X version, while deprecating support for Pyspark 2.X.

• Finally, NLU-Core features various new helper methods for working with Spark NLP and embellishes now the entire universe of Annotators defined by Spark NLP and Spark NLP for healthcare.

NLU 4.0 for Healthcare Overview

• On the healthcare side NLU features 20 Biomedical models for over 8 languages (English, French, Italian, Portuguese, Romanian, Catalan and Galician) detect entities like HUMAN and SPECIES based on LivingNER corpus

• Romanian models for Deidentification and extracting Medical entities like Measurements, Form, Symptom, Route, Procedure, Disease_Syndrome_Disorder, Score, Drug_Ingredient, Pulse, Frequency, Date, Body_Part, Drug_Brand_Name, Time, Direction, Dosage, Medical_Device, Imaging_Technique, Test, Imaging_Findings, Imaging_Test, Test_Result, Weight, Clinical_Dept and Units with SPELL and SPELL respectively

• English NER models for parsing entities in Clinical Trial Abstracts like Age, AllocationRatio, Author, BioAndMedicalUnit, CTAnalysisApproach, CTDesign, Confidence, Country, DisorderOrSyndrome, DoseValue, Drug, DrugTime, Duration, Journal, NumberPatients, PMID, PValue, PercentagePatients, PublicationYear, TimePoint, Value using en.med_ner.clinical_trials_abstracts.pipe and also Pathogen NER models for Pathogen, MedicalCondition, Medicine with en.med_ner.pathogen and GENE_PROTEIN with en.med_ner.biomedical_bc2gm.pipeline

•  First Public Health Model for Emotional Stress classification It is a PHS-BERT-based model and trained with the Dreaddit dataset using en.classify.stress

• 50 + new Entity Mappers for problems like :

  • Extract section headers in scientific articles and normalize them with en.map_entity.section_headers_normalized
  • Map medical abbreviates to their definitions with en.map_entity.abbreviation_to_definition
  • Map drugs to action and treatments with en.map_entity.drug_to_action_treatment
  • Map drug brand to their National Drug Code (NDC) with en.map_entity.drug_brand_to_ndc
  • Convert between terminologies using en.<START_TERMINOLOGY>_to_<TARGET_TERMINOLOGY>
    • This works for the terminologies rxnorm, ndc, umls, icd10cm, icdo, umls, snomed, mesh
      • snomed_to_icdo
      • snomed_to_icd10cm
      • rxnorm_to_umls
  • powerd by Spark NLP for Healthcares ChunkMapper Annotator

Extract Tables from PDF files as Pandas DataFrames

Sample PDF:

nlu.load('pdf2table').predict('/path/to/sample.pdf')  

Output of PDF Table OCR :

Extract Tables from DOC/DOCX files as Pandas DataFrames

Sample DOCX:

nlu.load('doc2table').predict('/path/to/sample.docx')  

Output of DOCX Table OCR :

Extract Tables from PPT files as Pandas DataFrame

Sample PPT with two tables:

nlu.load('ppt2table').predict('/path/to/sample.docx')  

Output of PPT Table OCR :

{:.table-model-big}{:.table-model-big} | Sepal.Length | Sepal.Width | Petal.Length | Petal.Width | Species |
|—————:|————–:|—————:|————–:|:———-|
| 5.1 | 3.5 | 1.4 | 0.2 | setosa |
| 4.9 | 3 | 1.4 | 0.2 | setosa |
| 4.7 | 3.2 | 1.3 | 0.2 | setosa |
| 4.6 | 3.1 | 1.5 | 0.2 | setosa |
| 5 | 3.6 | 1.4 | 0.2 | setosa |
| 5.4 | 3.9 | 1.7 | 0.4 | setosa |

and

Span Classifiers for question answering

Albert, Bert, DeBerta, DistilBert, LongFormer, RoBerta, XlmRoBerta based Transformer Architectures are now avaiable for question answering with almost 1000 models avaiable for 35 unique languages powerd by their corrosponding Spark NLP XXXForQuestionAnswering Annotator Classes and in various tuning and dataset flavours.

<lang>.answer_question.<domain>.<datasets>.<annotator_class><tune info>.by_<username> If multiple datasets or tune parameters are defined , they are connected with a _ .

These substrings define up the <domain> part of the NLU reference

• Legal cuad
• COVID 19 Biomedical biosaq
• Biomedical Literature pubmed
• Twitter tweet
• Wikipedia wiki
• News news
• Tech tech

These substrings define up the <dataset> part of the NLU reference

• Arabic SQUAD ARCD
• Turkish TQUAD
• German GermanQuad
• Indonesian AQG
• Korean KLUE, KORQUAD
• HindiCHAI
• Multi-LingualMLQA
• Multi-Lingualtydiqa
• Multi-Lingualxquad

These substrings define up the <dataset> part of the NLU reference

• Alternative Eval method reqa
• Synthetic Data synqa
• Benchmark / Eval Method ABSA-Bench roberta_absa
• Arabic architecture type soqaol

These substrings define the <annotator_class> substring, if it does not map to a sparknlp annotator

• sci_bert
• electra
• mini_lm
• covid_bert
• bio_bert
• indo_bert
• muril
• sapbert
• bioformer
• link_bert
• mac_bert

These substrings define the <tune_info> substring, if it does not map to a sparknlp annotator

• Train tweaks : multilingual,mini_lm,xtremedistiled,distilled,xtreme,augmented,zero_shot
• Size tweaks xl, xxl, large, base, medium, base, small, tiny, cased, uncased
• Dimension tweaks : 1024d,768d,512d,256d,128d,64d,32d

QA DataFormat

You need to use one of the Data formats below to pass context and question correctly to the model.

# use ||| to seperate question||context
data = 'What is my name?|||My name is Clara and I live in Berkeley'

# pass a tuple (question,context)
data = ('What is my name?','My name is Clara and I live in Berkeley')

# use pandas Dataframe, one column = question, one column=context
data = pd.DataFrame({
					 'question': ['What is my name?'],
					 'context': ["My name is Clara and I live in Berkely"]
					 })


# Get your answers with any of above formats 
nlu.load("en.answer_question.squadv2.deberta").predict(data)

returns :

New NLU helper Methods

You can see all features showcased in the notebook or on the new docs page for Spark NLP utils

nlu.viz(pipe,data)

Visualize input data with an already configured Spark NLP pipeline,
for Algorithms of type (Ner,Assertion, Relation, Resolution, Dependency)
using Spark NLP Display
Automatically infers applicable viz type and output columns to use for visualization.
Example:

# works with Pipeline, LightPipeline, PipelineModel,PretrainedPipeline List[Annotator]
ade_pipeline = PretrainedPipeline('explain_clinical_doc_ade', 'en', 'clinical/models')

text = """I have an allergic reaction to vancomycin.
My skin has be itchy, sore throat/burning/itchy, and numbness in tongue and gums.
I would not recommend this drug to anyone, especially since I have never had such an adverse reaction to any other medication."""

nlu.viz(ade_pipeline, text)

returns:

If a pipeline has multiple models candidates that can be used for a viz,
the first Annotator that is vizzable will be used to create viz.
You can specify which type of viz to create with the viz_type parameter

Output columns to use for the viz are automatically deducted from the pipeline, by using the first annotator that provides the correct output type for a specific viz.
You can specify which columns to use for a viz by using the
corresponding ner_col, pos_col, dep_untyped_col, dep_typed_col, resolution_col, relation_col, assertion_col, parameters.

nlu.autocomplete_pipeline(pipe)

Auto-Complete a pipeline or single annotator into a runnable pipeline by harnessing NLU’s DAG Autocompletion algorithm and returns it as NLU pipeline. The standard Spark pipeline is avaiable on the .vanilla_transformer_pipe attribute of the returned nlu pipe

Every Annotator and Pipeline of Annotators defines a DAG of tasks, with various dependencies that must be satisfied in topoligical order. NLU enables the completion of an incomplete DAG by finding or creating a path between the very first input node which is almost always is DocumentAssembler/MultiDocumentAssembler and the very last node(s), which is given by the topoligical sorting the iterable annotators parameter. Paths are created by resolving input features of annotators to the corrrosponding providers with matching storage references.

Example:

# Lets autocomplete the pipeline for a RelationExtractionModel, which as many input columns and sub-dependencies.
from sparknlp_jsl.annotator import RelationExtractionModel
re_model = RelationExtractionModel().pretrained("re_ade_clinical", "en", 'clinical/models').setOutputCol('relation')

text = """I have an allergic reaction to vancomycin.
My skin has be itchy, sore throat/burning/itchy, and numbness in tongue and gums.
I would not recommend this drug to anyone, especially since I have never had such an adverse reaction to any other medication."""

nlu_pipe = nlu.autocomplete_pipeline(re_model)
nlu_pipe.predict(text)

returns :

nlu.to_pretty_df(pipe,data)

Annotates a Pandas Dataframe/Pandas Series/Numpy Array/Spark DataFrame/Python List strings /Python String
with given Spark NLP pipeline, which is assumed to be complete and runnable and returns it in a pythonic pandas dataframe format.

Example:

# works with Pipeline, LightPipeline, PipelineModel,PretrainedPipeline List[Annotator]
ade_pipeline = PretrainedPipeline('explain_clinical_doc_ade', 'en', 'clinical/models')

text = """I have an allergic reaction to vancomycin.
My skin has be itchy, sore throat/burning/itchy, and numbness in tongue and gums.
I would not recommend this drug to anyone, especially since I have never had such an adverse reaction to any other medication."""

# output is same as nlu.autocomplete_pipeline(re_model).nlu_pipe.predict(text)
nlu.to_pretty_df(ade_pipeline,text)

returns :

Annotators are grouped internally by NLU into output levels token,sentence, document,chunk and relation Same level annotators output columns are zipped and exploded together to create the final output df. Additionally, most keys from the metadata dictionary in the result annotations will be collected and expanded into their own columns in the resulting Dataframe, with special handling for Annotators that encode multiple metadata fields inside of one, seperated by strings like ||| or :::. Some columns are omitted from metadata to reduce total amount of output columns, these can be re-enabled by setting metadata=True

For a given pipeline output level is automatically set to the last anntators output level by default. This can be changed by defining to_preddty_df(pipe,text,output_level='my_level' for levels token,sentence, document,chunk and relation .

nlu.to_nlu_pipe(pipe)

Convert a pipeline or list of annotators into a NLU pipeline making .predict() and .viz() avaiable for every Spark NLP pipeline. Assumes the pipeline is already runnable.

# works with Pipeline, LightPipeline, PipelineModel,PretrainedPipeline List[Annotator]
ade_pipeline = PretrainedPipeline('explain_clinical_doc_ade', 'en', 'clinical/models')

text = """I have an allergic reaction to vancomycin.
My skin has be itchy, sore throat/burning/itchy, and numbness in tongue and gums.
I would not recommend this drug to anyone, especially since I have never had such an adverse reaction to any other medication."""

nlu_pipe = nlu.to_nlu_pipe(ade_pipeline)

# Same output as nlu.to_pretty_df(pipe,text) 
nlu_pipe.predict(text)

# same output as nlu.viz(pipe,text)
nlu_pipe.viz(text)

# Acces auto-completed Spark NLP big data pipeline,
nlu_pipe.vanilla_transformer_pipe.transform(spark_df)

returns :

and

4 new Demo Notebooks

These notebooks showcase some of latest classifier models for Banking Queries, Intents in Text, Question and new s classification

• Notebook for Classification of Banking Queries
• Notebook for Classification of Intent in Texts
• Notebook for classification of Similar Questions
• Notebook for Classification of Questions vs Statements
• Notebook for Classification of News into 4 classes

NLU captures every Annotator of Spark NLP and Spark NLP for healthcare

The entire universe of Annotators in Spark NLP and Spark-NLP for healthcare is now embellished by NLU Components by using generalizable annotation extractors methods and configs internally to support enable the new NLU util methods. The following annotator classes are newly captured:

• AssertionFilterer
• ChunkConverter
• ChunkKeyPhraseExtraction
• ChunkSentenceSplitter
• ChunkFiltererApproach
• ChunkFilterer
• ChunkMapperApproach
• ChunkMapperFilterer
• DocumentLogRegClassifierApproach
• DocumentLogRegClassifierModel
• ContextualParserApproach
• ReIdentification
• NerDisambiguator
• NerDisambiguatorModel
• AverageEmbeddings
• EntityChunkEmbeddings
• ChunkMergeApproach
• ChunkMergeApproach
• IOBTagger
• NerChunker
• NerConverterInternalModel
• DateNormalizer
• PosologyREModel
• RENerChunksFilter
• ResolverMerger
• AnnotationMerger
• Router
• Word2VecApproach
• WordEmbeddings
• EntityRulerApproach
• EntityRulerModel
• TextMatcherModel
• BigTextMatcher
• BigTextMatcherModel
• DateMatcher
• MultiDateMatcher
• RegexMatcher
• TextMatcher
• NerApproach
• NerCrfApproach
• NerOverwriter
• DependencyParserApproach
• TypedDependencyParserApproach
• SentenceDetectorDLApproach
• SentimentDetector
• ViveknSentimentApproach
• ContextSpellCheckerApproach
• NorvigSweetingApproach
• SymmetricDeleteApproach
• ChunkTokenizer
• ChunkTokenizerModel
• RecursiveTokenizer
• RecursiveTokenizerModel
• Token2Chunk
• WordSegmenterApproach
• GraphExtraction
• Lemmatizer
• Normalizer

All NLU 4.0 for Healthcare Models

Some examples:

en.rxnorm.umls.mapping

Code:

nlu.load('en.rxnorm.umls.mapping').predict('1161611 315677')

en.ner.clinical_trials_abstracts

Code:

nlu.load('en.ner.clinical_trials_abstracts').predict('A one-year, randomised, multicentre trial comparing insulin glargine with NPH insulin in combination with oral agents in patients with type 2 diabetes.')

Results:

Code:

nlu.load('en.ner.clinical_trials_abstracts').viz('A one-year, randomised, multicentre trial comparing insulin glargine with NPH insulin in combination with oral agents in patients with type 2 diabetes.')

Results:

en.med_ner.pathogen

Code:

nlu.load('en.med_ner.pathogen').predict('Racecadotril is an antisecretory medication and it has better tolerability than loperamide. Diarrhea is the condition of having loose, liquid or watery bowel movements each day. Signs of dehydration often begin with loss of the normal stretchiness of the skin. While it has been speculated that rabies virus, Lyssavirus and Ephemerovirus could be transmitted through aerosols, studies have concluded that this is only feasible in limited conditions.')

Results:

Code:

nlu.load('en.med_ner.pathogen').viz('Racecadotril is an antisecretory medication and it has better tolerability than loperamide. Diarrhea is the condition of having loose, liquid or watery bowel movements each day. Signs of dehydration often begin with loss of the normal stretchiness of the skin. While it has been speculated that rabies virus, Lyssavirus and Ephemerovirus could be transmitted through aerosols, studies have concluded that this is only feasible in limited conditions.')

Results:

es.med_ner.living_species.roberta

Code:

nlu.load('es.med_ner.living_species.roberta').predict('Lactante varón de dos años. Antecedentes familiares sin interés. Antecedentes personales: Embarazo, parto y periodo neonatal normal. En seguimiento por alergia a legumbres, diagnosticado con diez meses por reacción urticarial generalizada con lentejas y garbanzos, con dieta de exclusión a legumbres desde entonces. En ésta visita la madre describe episodios de eritema en zona maxilar derecha con afectación ocular ipsilateral que se resuelve en horas tras la administración de corticoides. Le ha ocurrido en 5-6 ocasiones, en relación con la ingesta de alimentos previamente tolerados. Exploración complementaria: Cacahuete, ac(ige)19.2 Ku.arb/l. Resultados: Ante la sospecha clínica de Síndrome de Frey, se tranquiliza a los padres, explicándoles la naturaleza del cuadro y se cita para revisión anual.')

Results:

Code:

nlu.load('es.med_ner.living_species.roberta').viz('Lactante varón de dos años. Antecedentes familiares sin interés. Antecedentes personales: Embarazo, parto y periodo neonatal normal. En seguimiento por alergia a legumbres, diagnosticado con diez meses por reacción urticarial generalizada con lentejas y garbanzos, con dieta de exclusión a legumbres desde entonces. En ésta visita la madre describe episodios de eritema en zona maxilar derecha con afectación ocular ipsilateral que se resuelve en horas tras la administración de corticoides. Le ha ocurrido en 5-6 ocasiones, en relación con la ingesta de alimentos previamente tolerados. Exploración complementaria: Cacahuete, ac(ige)19.2 Ku.arb/l. Resultados: Ante la sospecha clínica de Síndrome de Frey, se tranquiliza a los padres, explicándoles la naturaleza del cuadro y se cita para revisión anual.')

Results:

All healthcare models added in NLU 4.0 :

All NLU 4.0 Core Models

All core models added in NLU 4.0 : Can be found on the NLU website because of Github Limitations