Update README.md

README.md

@@ -1,7 +1,8 @@
 ---
 license: apache-2.0
+language: es
 tags:
-- generated_from_trainer
+- "spanish"
 datasets:
 - catalonia_independence
 metrics:
@@ -20,29 +21,24 @@ model-index:
     - name: Accuracy
       type: accuracy
       value: 0.7880893300248138
+widget:
+ - text: "Junqueras, sobre la decisión judicial sobre Puigdemont: La justicia que falta en el Estado llega y llegará de Europa"
+ - text: "Desconvocada la manifestación del domingo en Barcelona en apoyo a Puigdemont"
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-# roberta-base-bne-finetuned-mnli
+# roberta-base-bne-finetuned-catalonia-independence-detector
 
 This model is a fine-tuned version of [BSC-TeMU/roberta-base-bne](https://huggingface.co/BSC-TeMU/roberta-base-bne) on the catalonia_independence dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.9415
 - Accuracy: 0.7881
 
-## Model description
-
-More information needed
+<details>
 
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
+## Model description
 
-More information needed
+The data was collected over 12 days during February and March of 2019 from tweets posted in Barcelona, and during September of 2018 from tweets posted in the town of Terrassa, Catalonia.
+Each corpus is annotated with three classes: AGAINST, FAVOR and NEUTRAL, which express the stance towards the target - independence of Catalonia.
 
 ## Training procedure
 
@@ -67,6 +63,42 @@ The following hyperparameters were used during training:
 | 0.0605        | 4.0   | 1512 | 0.8809          | 0.7866   |
 | 0.0605        | 5.0   | 1890 | 0.9415          | 0.7881   |
 
+</details>
+
+### Model in action 🚀
+
+Fast usage with **pipelines**:
+
+```python
+
+from transformers import pipeline
+
+model_path = "JonatanGk/roberta-base-bne-finetuned-catalonia-independence-detector"
+independence_analysis = pipeline("text-classification", model=model_path, tokenizer=model_path)
+
+independence_analysis(
+    "Junqueras, sobre la decisión judicial sobre Puigdemont: La justicia que falta en el Estado llega y llegará de Europa"
+    )
+
+# Output:
+[{'label': 'FAVOR', 'score': 0.9936726093292236}]
+
+independence_analysis(
+    "El desafío independentista queda adormecido, y eso que el Gobierno ha sido muy claro en que su propuesta para Cataluña es una agenda de reencuentro, centrada en inversiones e infraestructuras")
+
+# Output:
+[{'label': 'AGAINST', 'score': 0.7508948445320129}]
+
+independence_analysis(
+    "Desconvocada la manifestación del domingo en Barcelona en apoyo a Puigdemont"
+    )
+
+# Output:
+[{'label': 'NEUTRAL', 'score': 0.9966907501220703}]
+
+```
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/JonatanGk/Shared-Colab/blob/master/Catalonia_independence_Detector_(SPANISH).ipynb#scrollTo=uNMOXJz38W6U)
 
 ### Framework versions
 
@@ -74,3 +106,11 @@ The following hyperparameters were used during training:
 - Pytorch 1.9.0+cu111
 - Datasets 1.12.1
 - Tokenizers 0.10.3
+
+## Citation
+Thx to HF.co & [@lewtun](https://github.com/lewtun) for Dataset ;)
+
+
+> Special thx to [Manuel Romero/@mrm8488](https://huggingface.co/mrm8488) as my mentor & R.C.
+
+> Created by [Jonatan Luna](https://JonatanGk.github.io) | [LinkedIn](https://www.linkedin.com/in/JonatanGk/)