Description
This model is a Binary Classifier (True, False) for the confidentiality
clause type. To use this model, make sure you provide enough context as an input. Adding Sentence Splitters to the pipeline will make the model see only sentences, not the whole text, so it’s better to skip it, unless you want to do Binary Classification as sentence level.
If you have big legal documents, and you want to look for clauses, we recommend you to split the documents using any of the techniques available in our Legal NLP Workshop Tokenization & Splitting Tutorial (link here), namely:
- Paragraph splitting (by multiline);
- Splitting by headers / subheaders;
- etc.
Take into consideration the embeddings of this model allows up to 512 tokens. If you have more than that, consider splitting in smaller pieces (you can also check the same tutorial link provided above).
This model can be combined with any of the other “hundreds” of Legal Clauses Classifiers you will find in Models Hub, getting as an output a series of True/False values for each of the legal clause model you have added.
Predicted Entities
other
, confidentiality
How to use
documentAssembler = nlp.DocumentAssembler() \
.setInputCol("clause_text") \
.setOutputCol("document")
embeddings = nlp.BertSentenceEmbeddings.pretrained("sent_bert_base_cased", "en") \
.setInputCols("document") \
.setOutputCol("sentence_embeddings")
docClassifier = nlp.ClassifierDLModel.pretrained("legclf_confidential_clause", "en", "legal/models")\
.setInputCols(["sentence_embeddings"])\
.setOutputCol("category")
nlpPipeline = nlp.Pipeline(stages=[
documentAssembler,
embeddings,
docClassifier])
df = spark.createDataFrame([["YOUR TEXT HERE"]]).toDF("clause_text")
model = nlpPipeline.fit(df)
result = model.transform(df)
Results
+-------+
| result|
+-------+
|[confidentiality]|
|[other]|
|[other]|
|[confidentiality]|
Model Information
Model Name: | legclf_cuad_confidentiality_clause |
Type: | legal |
Compatibility: | Legal NLP 1.0.0+ |
License: | Licensed |
Edition: | Official |
Input Labels: | [sentence_embeddings] |
Output Labels: | [category] |
Language: | en |
Size: | 22.2 MB |
References
In-house annotations on CUAD dataset
Benchmarking
label precision recall f1-score support
confidentiality 1.00 0.91 0.95 11
other 0.95 1.00 0.97 19
accuracy - - 0.97 30
macro-avg 0.97 0.95 0.96 30
weighted-avg 0.97 0.97 0.97 30