Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,84 @@
|
|
1 |
---
|
|
|
|
|
2 |
license: cc-by-4.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
+
language:
|
3 |
+
- en
|
4 |
license: cc-by-4.0
|
5 |
+
datasets:
|
6 |
+
- cuad
|
7 |
+
pipeline_tag: question-answering
|
8 |
+
tags:
|
9 |
+
- legal-contract-review
|
10 |
+
- roberta
|
11 |
+
- cuad
|
12 |
+
library_name: transformers
|
13 |
---
|
14 |
+
# Model Card for cuad-roberta-base
|
15 |
+
|
16 |
+
# Model Details
|
17 |
+
|
18 |
+
## Model Description
|
19 |
+
|
20 |
+
- **Developed by:** Hendrycks et al.
|
21 |
+
- **Model type:** Question Answering
|
22 |
+
- **Language(s) (NLP):** en
|
23 |
+
- **License:** cc-by-4.0
|
24 |
+
- **Related Models:**
|
25 |
+
- **Parent Model:** DeBERTa-v2
|
26 |
+
- **Resources for more information:**
|
27 |
+
- GitHub Repo: [TheAtticusProject](https://github.com/TheAtticusProject/cuad)
|
28 |
+
- Associated Paper: [CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review](https://arxiv.org/abs/2103.06268)
|
29 |
+
- Project website: [Contract Understanding Atticus Dataset (CUAD)](https://www.atticusprojectai.org/cuad)
|
30 |
+
|
31 |
+
# Uses
|
32 |
+
|
33 |
+
## Direct Use
|
34 |
+
|
35 |
+
This model can be used for the task of Question Answering on Legal Documents.
|
36 |
+
|
37 |
+
# Training Details
|
38 |
+
|
39 |
+
Read: [CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review](https://arxiv.org/abs/2103.06268)
|
40 |
+
for detailed information on training procedure, dataset preprocessing and evaluation.
|
41 |
+
|
42 |
+
## Training Data, Procedure, Preprocessing, etc.
|
43 |
+
|
44 |
+
See [CUAD dataset card](https://huggingface.co/datasets/cuad) for more information.
|
45 |
+
|
46 |
+
# Evaluation
|
47 |
+
|
48 |
+
## Testing Data, Factors & Metrics
|
49 |
+
|
50 |
+
### Testing Data
|
51 |
+
|
52 |
+
See [CUAD dataset card](https://huggingface.co/datasets/cuad) for more information.
|
53 |
+
|
54 |
+
### Software
|
55 |
+
|
56 |
+
Python, Transformers
|
57 |
+
|
58 |
+
# Citation
|
59 |
+
|
60 |
+
**BibTeX:**
|
61 |
+
```
|
62 |
+
@article{hendrycks2021cuad,
|
63 |
+
title={CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review},
|
64 |
+
author={Dan Hendrycks and Collin Burns and Anya Chen and Spencer Ball},
|
65 |
+
journal={NeurIPS},
|
66 |
+
year={2021}
|
67 |
+
}
|
68 |
+
```
|
69 |
+
|
70 |
+
# How to Get Started with the Model
|
71 |
+
|
72 |
+
Use the code below to get started with the model.
|
73 |
+
|
74 |
+
<details>
|
75 |
+
<summary> Click to expand </summary>
|
76 |
+
|
77 |
+
```python
|
78 |
+
from transformers import AutoTokenizer, AutoModelForQuestionAnswering
|
79 |
+
|
80 |
+
tokenizer = AutoTokenizer.from_pretrained("mgigena/cuad-deberta-v2-xlarge")
|
81 |
+
|
82 |
+
model = AutoModelForQuestionAnswering.from_pretrained("mgigena/cuad-deberta-v2-xlarge")
|
83 |
+
```
|
84 |
+
</details>
|