Update README.md

README.md

@@ -5,7 +5,8 @@ tags: []
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+This model is a fine-tuned version of [FacebookAI/xlm-roberta-large-finetuned-conll03-english](https://huggingface.co/FacebookAI/xlm-roberta-large-finetuned-conll03-english) on a synthetic Named Entity Recognition (NER) dataset in Bahasa Indonesia. 
+The dataset contains 25,000 samples in BIO format with annotations for various entity types.
 
 
 
@@ -17,197 +18,195 @@ tags: []
 
 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]
+- **Base Model:** Roberta
+- **Model type:** Token Classification
+- **Language(s) (NLP):** Bahasa Indonesia
+- **Finetuned from model [optional]:** xlm-roberta-large-finetuned-conll03-english
 
-### Model Sources [optional]
+<!-- ### Model Sources [optional] -->
 
 <!-- Provide the basic links for the model. -->
-
+<!-- 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed] -->
 
-## Uses
+<!-- ## 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
+<!-- ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Downstream Use [optional]
+<!-- ### 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]
+<!-- [More Information Needed] -->
 
-### Out-of-Scope Use
+<!-- ### Out-of-Scope Use -->
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. --> --> -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Bias, Risks, and Limitations
+<!-- ## Bias, Risks, and Limitations -->
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Recommendations
+<!-- ### 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
+<!-- ## How to Get Started with the Model -->
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+<!-- [More Information Needed] -->
+
+<!-- ## Training Details -->
 
-## Training Details
+### Training Performance
+| Epoch | Training Loss          | Training Accuracy         |
+|-------|------------------------|---------------------------|
+| 1     | 0.012390273481311305    | 0.9912830868740373         |
+| 2     | 0.002953063364330592    | 0.9979232802183077         |
 
-### 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]
+<!-- [More Information Needed] -->
 
-### Training Procedure
+<!-- ### 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]
+<!-- #### Preprocessing [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 
-#### Training Hyperparameters
+<!-- #### 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 -->
+<!-- - **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]
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
-
-## Evaluation
+<!-- [More Information Needed] -->
+
+### Performance
+| Entity Type | Precision | Recall | F1-Score | Support |
+|-------------|-----------|--------|----------|---------|
+| DATE_TIME   | 1.00      | 0.99   | 0.99     | 1474    |
+| EMAIL       | 1.00      | 1.00   | 1.00     | 8936    |
+| GENDER      | 1.00      | 1.00   | 1.00     | 1142    |
+| LOC         | 1.00      | 0.99   | 1.00     | 8295    |
+| PER         | 1.00      | 1.00   | 1.00     | 17005   |
+| PHONE       | 1.00      | 1.00   | 1.00     | 5845    |
+| SSN         | 1.00      | 1.00   | 1.00     | 16654   |
+| **Micro Avg** | 1.00    | 1.00   | 1.00     | 59351   |
+| **Macro Avg** | 1.00    | 1.00   | 1.00     | 59351   |
+| **Weighted Avg** | 1.00 | 1.00   | 1.00     | 59351   |
+
+Validation Loss: 0.0009539824152059737
+Validation Accuracy: 0.999389430961554
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics -->
 
-#### Testing Data
+<!-- #### Testing Data -->
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Factors
+<!-- #### Factors -->
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Metrics
-**Training loss epoch:** 0.005518221071622179 \
-**Training accuracy epoch:** 0.9964884720585756 \
-**Validation Loss:** 0.0042953278648501505 \
-**Validation Accuracy:** 0.9976648087554244
 
-[More Information Needed]
 
-### Results
 
-| Entity     | Precision | Recall | F1-Score | Support |
-|------------|-----------|--------|----------|---------|
-| ACCOUNT    | 0.99      | 1.00   | 1.00     | 6000    |
-| DOB        | 1.00      | 1.00   | 1.00     | 1631    |
-| EMAIL      | 1.00      | 1.00   | 1.00     | 12169   |
-| ID         | 1.00      | 0.99   | 0.99     | 4321    |
-| LOCATION   | 0.99      | 0.99   | 0.99     | 11748   |
-| PERSON     | 0.99      | 0.98   | 0.99     | 7339    |
-| PHONE      | 1.00      | 1.00   | 1.00     | 7272    |
-| **micro avg**  | 0.99   | 0.99   | 0.99     | 50480   |
-| **macro avg**  | 1.00   | 1.00   | 1.00     | 50480   |
-| **weighted avg** | 0.99 | 0.99   | 0.99     | 50480   |
 
 
-#### Summary
+<!-- #### Summary -->
+<!--  -->
 
 
-
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Environmental Impact
+<!-- ## 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).
-
+<!-- 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]
+- **Carbon Emitted:** [More Information Needed] -->
 
-### Model Architecture and Objective
+<!-- ## Technical Specifications [optional] -->
 
-[More Information Needed]
+<!-- ### Model Architecture and Objective -->
 
-### Compute Infrastructure
+<!-- [More Information Needed] -->
 
-[More Information Needed]
+<!-- ### Compute Infrastructure -->
 
-#### Hardware
+<!-- [More Information Needed] -->
+<!--  -->
+<!-- #### Hardware -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Software
+<!-- #### Software -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Citation [optional]
+<!-- ## 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:**
+<!-- **BibTeX:** -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-**APA:**
+<!-- **APA:** -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Glossary [optional]
+<!-- ## 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 Needed] -->
 
-## More Information [optional]
+<!-- ## More Information [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Authors [optional]
+<!-- ## Model Card Authors [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Contact
+<!-- ## Model Card Contact -->
 
-[More Information Needed]
+<!-- [More Information Needed] --> -->