Update README.md

README.md

@@ -1,3 +1,151 @@
 ---
+language:
+- en
 license: cc-by-4.0
+datasets:
+- cuad
+pipeline_tag: question-answering
+tags:
+- legal-contract-review
+- roberta
+- cuad
+library_name: transformers
 ---
+# Model Card for cuad-roberta-base
+  
+# Model Details
+ 
+## Model Description
+ 
+- **Developed by:** Hendrycks et al.
+- **Shared by [Optional]:** More information needed
+- **Model type:** Question Answering 
+- **Language(s) (NLP):** en
+- **License:** cc-by-4.0
+- **Related Models:**
+  - **Parent Model:** RoBERTa 
+- **Resources for more information:** 
+    - GitHub Repo: [TheAtticusProject](https://github.com/TheAtticusProject/cuad)
+    - Associated Paper: [CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review](https://arxiv.org/abs/2103.06268)
+    - Project website: [Contract Understanding Atticus Dataset (CUAD)](https://www.atticusprojectai.org/cuad)
+ 
+ 
+ 
+ 
+# Uses
+ 
+ 
+## Direct Use
+ 
+This model can be used for the task of Question Answering on Legal Documents.
+ 
+# Training Details
+
+Read: [CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review](https://arxiv.org/abs/2103.06268) 
+for detailed information on training procedure, dataset preprocessing and evaluation.
+ 
+## Training Data
+ 
+See [CUAD dataset card](https://huggingface.co/datasets/cuad) for more information.
+ 
+## Training Procedure
+
+More information needed
+
+### Preprocessing
+ 
+More information needed
+ 
+### Speeds, Sizes, Times
+ 
+More information needed
+ 
+# Evaluation
+ 
+ 
+## Testing Data, Factors & Metrics
+ 
+### Testing Data
+ 
+See [CUAD dataset card](https://huggingface.co/datasets/cuad) for more information.
+ 
+### Factors
+More information needed
+ 
+### Metrics
+More information needed
+
+## Results 
+More information needed
+ 
+# Model Examination 
+More information needed
+  
+- **Hardware Type:** More information needed
+- **Hours used:** More information needed
+- **Cloud Provider:** More information needed
+- **Compute Region:** More information needed
+- **Carbon Emitted:** More information needed
+ 
+# Technical Specifications [optional]
+ 
+## Model Architecture and Objective
+ 
+More information needed
+ 
+## Compute Infrastructure
+ 
+More information needed
+ 
+### Hardware
+ 
+Used V100/P100 from Google Colab Pro
+ 
+### Software
+
+Python, Transformers
+ 
+# Citation
+ 
+ 
+**BibTeX:**
+ ```
+@article{hendrycks2021cuad,
+      title={CUAD: An Expert-Annotated NLP Dataset for Legal Contract Review}, 
+      author={Dan Hendrycks and Collin Burns and Anya Chen and Spencer Ball},
+      journal={NeurIPS},
+      year={2021}
+}
+```
+ 
+ 
+# Glossary [optional]
+More information needed
+ 
+# More Information [optional]
+ 
+More information needed
+ 
+# Model Card Authors [optional]
+  
+Mohammed Rakib in collaboration with Ezi Ozoani and the Hugging Face team
+ 
+# Model Card Contact
+ 
+More information needed
+ 
+# How to Get Started with the Model
+ 
+Use the code below to get started with the model.
+ 
+<details>
+<summary> Click to expand </summary>
+
+```python
+from transformers import AutoTokenizer, AutoModelForQuestionAnswering
+ 
+tokenizer = AutoTokenizer.from_pretrained("mgigena/cuad-roberta-base")
+ 
+model = AutoModelForQuestionAnswering.from_pretrained("mgigena/cuad-roberta-base")
+```
+</details>