Update README.md

README.md

@@ -2,72 +2,94 @@
 library_name: transformers
 language: en
 license: apache-2.0
-datasets: []
-tags: []
+datasets:
+- cglez/civil_comments_clean
+base_model:
+- google-bert/bert-base-uncased
 ---
 
-# Model Card for <Model>
+# Model Card: BERT Civil Comments
 
-A pretrained BERT using <Dataset>.
+An in-domain BERT-base model, pre-trained from scratch on the Civil Comments dataset text.
 
 ## Model Details
 
-### Model Description
+### Description
 
-A MLM-only pretrained BERT-base using <Dataset>.
+This model is based on the [BERT base (uncased)](https://huggingface.co/google-bert/bert-base-uncased)
+architecture and was pre-trained from scratch (in-domain) using the text in Civil Comments dataset, excluding its test split.
+Only the masked language modeling (MLM) objective was used during pre-training.
 
 - **Developed by:** [Cesar Gonzalez-Gutierrez](https://ceguel.es)
 - **Funded by:** [ERC](https://erc.europa.eu)
-- **Model type:** MLM pretrained BERT
-- **Language(s) (NLP):** English
-- **License:** Apache license 2.0
-- **Pretrained from model:** [BERT base model (uncased)](https://huggingface.co/google-bert/bert-base-uncased)
+- **Architecture:** BERT-base
+- **Language:** English
+- **License:** Apache 2.0
+- **Base model:** [BERT base model (uncased)](https://huggingface.co/google-bert/bert-base-uncased)
 
-### Model Checkpoints
+### Checkpoints
 
-[More Information Needed]
-
-### Model Sources
-
-- **Paper:** [More Information Needed]
-
-## Uses
+Intermediate checkpoints from the pre-training process are available and can be accessed using specific tags,
+which correspond to training epochs and steps:
 
-See <https://huggingface.co/google-bert/bert-base-uncased#intended-uses--limitations>.
+| Epoch | Step | Tags | |
+|---|---|---|---|
+| 1 | 17833 | epoch-1 | step-17833 |
+| 2 | 35666 | epoch-2 | step-35666 |
+| 3 | 53499 | epoch-3 | step-53499 |
+| 5 | 89166 | epoch-5 | step-89166 |
+| 10 | 178330 | epoch-10 | step-178330 |
+| 15 | 267495 | epoch-15 | step-267495 |
+| 20 | 356660 | epoch-20 | step-356660 |
+| 25 | 445825 | epoch-25 | step-445825 |
 
-### Checkpoint Use
+To load a model from a specific intermediate checkpoint, use the `revision` parameter with the corresponding tag:
+```python
+from transformers import AutoModelForMaskedLM
 
-[More Information Needed]
+model = AutoModelForMaskedLM.from_pretrained("<model-name>", revision="<checkpoint-tag>")
+```
 
-## Bias, Risks, and Limitations
+### Sources
 
-See <https://huggingface.co/google-bert/bert-base-uncased#limitations-and-bias>.
+- **Paper:** [Information pending]
 
 ## Training Details
 
-See <https://huggingface.co/google-bert/bert-base-uncased#training-procedure>.
+For more details on the training procedure, please refer to the base model's documentation:
+[Training procedure](https://huggingface.co/google-bert/bert-base-uncased#training-procedure).
 
 ### Training Data
 
-[More Information Needed]
+All texts from Civil Comments dataset, excluding the test partition.
 
-#### Preprocessing [optional]
+#### Preprocessing
 
-[More Information Needed]
+All markup and symbols were removed from the texts, including punctuation.
 
 #### Training Hyperparameters
 
-- **Training regime:** fp16
+- **Precision:** fp16
 - **Batch size:** 32
 - **Gradient accumulation steps:** 3
 
+## Uses
+
+For typical use cases and limitations, please refer to the base model's guidance: 
+[Inteded uses & limitations](https://huggingface.co/google-bert/bert-base-uncased#intended-uses--limitations).
+
+## Bias, Risks, and Limitations
+
+This model inherits potential risks and limitations from the base model. Refer to:
+[Limitations and bias](https://huggingface.co/google-bert/bert-base-uncased#limitations-and-bias).
+
 ## Environmental Impact
 
 - **Hardware Type:** NVIDIA Tesla V100 PCIE 32GB
-- **Hours used:** [More Information Needed]
+- **Hours used:** 37
 - **Cluster Provider:** [Artemisa](https://artemisa.ific.uv.es/web/)
 - **Compute Region:** EU
-- **Carbon Emitted:** [More Information Needed] <!-- 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 Emitted:** 6.88 kg CO2 eq.
 
 ## Citation