| --- |
| license: apache-2.0 |
| datasets: |
| - Babelscape/multinerd |
| language: |
| - en |
| metrics: |
| - f1 |
| - precision |
| - recall |
| pipeline_tag: token-classification |
| tags: |
| - ner |
| - named-entity-recognition |
| - token-classification |
| model-index: |
| - name: robert-base on MultiNERD by Jayant Yadav |
| results: |
| - task: |
| type: named-entity-recognition-ner |
| name: Named Entity Recognition |
| dataset: |
| type: Babelscape/multinerd |
| name: MultiNERD (English) |
| split: test |
| revision: 2814b78e7af4b5a1f1886fe7ad49632de4d9dd25 |
| config: Babelscape/multinerd |
| args: |
| split: train[:50%] |
| metrics: |
| - type: f1 |
| value: 0.943 |
| name: F1 |
| - type: precision |
| value: 0.939 |
| name: Precision |
| - type: recall |
| value: 0.947 |
| name: Recall |
| config: seqeval |
| paper: https://aclanthology.org/2022.findings-naacl.60.pdf |
| base_model: roberta-base |
| library_name: transformers |
| --- |
| # Model Card for Model ID |
|
|
| <!-- Provide a quick summary of what the model is/does. --> |
|
|
| This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1). |
|
|
| ## Model Details |
|
|
| ### Model Description |
|
|
| <!-- Provide a longer summary of what this model is. --> |
|
|
|
|
|
|
| - **Developed by:** [More Information Needed] |
| - **Funded by [optional]:** [More Information Needed] |
| - **Shared by [optional]:** [More Information Needed] |
| - **Model type:** [More Information Needed] |
| - **Language(s) (NLP):** [More Information Needed] |
| - **License:** [More Information Needed] |
| - **Finetuned from model [optional]:** [More Information Needed] |
|
|
| ### Model Sources [optional] |
|
|
| <!-- Provide the basic links for the model. --> |
|
|
| - **Repository:** [More Information Needed] |
| - **Paper [optional]:** [More Information Needed] |
| - **Demo [optional]:** [More Information Needed] |
|
|
| ## Uses |
|
|
| <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. --> |
|
|
| ### Direct Use |
|
|
| <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. --> |
|
|
| [More Information Needed] |
|
|
| ## Bias, Risks, and Limitations |
|
|
| Only trained on English split of MultiNERD dataset. Therefore will not perform well on other languages. |
| <!-- This section is meant to convey both technical and sociotechnical limitations. --> |
|
|
| [More Information Needed] |
|
|
| ### Recommendations |
|
|
| <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. --> |
|
|
| Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. |
|
|
| ## How to Get Started with the Model |
|
|
| Use the code below to get started with the model. |
|
|
| [More Information Needed] |
|
|
| ## Training Details |
|
|
| ### Training Data |
|
|
| <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. --> |
|
|
| [More Information Needed] |
|
|
| ### Training Procedure |
|
|
| <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. --> |
|
|
| #### Preprocessing [optional] |
|
|
| [More Information Needed] |
|
|
|
|
| #### Training Hyperparameters |
|
|
| - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> |
|
|
| #### Speeds, Sizes, Times [optional] |
|
|
| <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. --> |
|
|
| [More Information Needed] |
|
|
| ## Evaluation |
|
|
| <!-- This section describes the evaluation protocols and provides the results. --> |
|
|
| ### Testing Data & Metrics |
|
|
| #### Testing Data |
|
|
| <!-- This should link to a Dataset Card if possible. --> |
|
|
| [More Information Needed] |
|
|
|
|
| #### Metrics |
|
|
| <!-- These are the evaluation metrics being used, ideally with a description of why. --> |
|
|
| [More Information Needed] |
|
|
| ### Results |
|
|
| [More Information Needed] |
|
|
|
|
| ## Technical Specifications [optional] |
|
|
| ### Model Architecture and Objective |
| Follows the same as RoBERTa-BASE |
| [More Information Needed] |
|
|
| ### Compute Infrastructure |
| 2x T4 GPUs |
| [More Information Needed] |
|
|
| #### Hardware |
|
|
| [More Information Needed] |
|
|
| #### Software |
| Pytorch |
| [More Information Needed] |
|
|
|
|
| ## Model Card Contact |
| (jayant-yadav)[https://huggingface.co/jayant-yadav] |
| [More Information Needed] |
