sabaridsnfuji
/

xlm-roberta-name-entity-recognition-japanese

Safetensors

xlm-roberta

Model card Files Files and versions Community

sabarinathan commited on Sep 17

Commit

be2a0d9

•

1 Parent(s): 418dd3b

Update README.md

Browse files

Files changed (1) hide show

README.md +79 -164

README.md CHANGED Viewed

@@ -1,199 +1,114 @@
----
-library_name: transformers
-tags: []
----
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **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]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- 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, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **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
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

+library_name: transformers
+license: apache-2.0
+language:
+- ja
+base_model:
+- FacebookAI/xlm-roberta-base
+# Japanese Named Entity Recognition (NER)
+This model is built using XLM-RoBERTa for Japanese text to recognize named entities such as persons, organizations, locations, and other categories. The model is designed specifically for Japanese text and can be used for a variety of tasks that require entity extraction from Japanese documents or conversations.
+## Table of Contents
+- [Overview](#overview)
+- [NER Tags](#ner-tags)
+- [Model Details](#model-details)
+- [Sample Input and Output](#sample-input-and-output)
+## Overview
+Named Entity Recognition (NER) is a critical task in natural language processing (NLP) for identifying and classifying entities in text. This model recognizes named entities in Japanese, making it ideal for use in applications like document analysis, chatbots, or information retrieval in the Japanese language.
+## NER Tags
+The model identifies the following tags:
+| Class ID | Tag   | Description          |
+|----------|-------|----------------------|
+| 0        | O     | Outside any entity   |
+| 1        | PER   | Person names         |
+| 2        | ORG   | Organizations        |
+| 3        | ORG-P | Political orgs       |
+| 4        | ORG-O | Other orgs           |
+| 5        | LOC   | Locations            |
+| 6        | INS   | Institutions         |
+| 7        | PRD   | Products             |
+| 8        | EVT   | Events               |
+## Model Details
+- **Base Model**: `xlm-roberta-base`
+- **Task**: Token Classification (NER)
+- **Languages**: Japanese
+- **Input**: Japanese text
+- **Output**: Tokenized text with NER tags
+## Sample Input and Output
+Here’s an example input sentence and the expected NER output.
+### **Input**
+```text
+中国では、中国共産党による一党統治が続く。
+```
+### **Output**
+| Token   | Predicted Tag |
+|---------|---------------|
+| 中国    | LOC           |
+| では    | O             |
+| 、      | O             |
+| 中国    | ORG-P         |
+| 共産党   | ORG-P         |
+| による  | O             |
+| 一党    | O             |
+| 統治    | O             |
+| が      | O             |
+| 続く    | O             |
+| 。      | O             |
+### Visualization with Gradio and spaCy
+The NER output is also visualized in color-coded format for ease of interpretation:
+**Entities Output:**
+- `LOC` (Location): China (中国)
+- `ORG-P` (Political Organization): Chinese Communist Party (中国共産党)
+Here’s the updated README section with the class names replacing the class IDs:
+---
+## Model Performance Metrics
+The following performance metrics were achieved by the model during evaluation:
+### Overall Metrics:
+- **Total Accuracy**: 98.42%
+- **Total F1-score**: 99.33%
+### Class-wise Metrics:
+| Class    | Recall    | Precision |
+|----------|-----------|-----------|
+| **O**    | 99.94%    | 99.00%    |
+| **PER**  | 97.53%    | 98.80%    |
+| **ORG**  | 99.22%    | 96.23%    |
+| **ORG-P**| 95.30%    | 99.71%    |
+| **ORG-O**| 97.80%    | 98.26%    |
+| **LOC**  | 99.03%    | 96.71%    |
+| **INS**  | 98.88%    | 99.07%    |
+| **PRD**  | 99.31%    | 99.67%    |
+| **EVT**  | 98.96%    | 98.31%    |
+The model demonstrates strong overall performance, with particularly high F1-scores and balanced class-wise precision and recall values.