Update README.md

README.md

@@ -6,6 +6,13 @@ tags:
 - generated_from_trainer
 - sentiment
 - emotion
+- suicide
+- depresión
+- suicidio
+- español
+- es
+- spanish
+- depression
 widget:
 - text: "La vida no merece la pena"
   example_title: "Ejemplo 1"
@@ -24,29 +31,50 @@ model-index:
 - name: electricidad-small-discriminator-finetuned-clasificacion-comentarios-suicidas 
   results: []
 ---
-<!-- 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. -->
+
 # electricidad-small-discriminator-finetuned-clasificacion-comentarios-suicidas 
-This model is a fine-tuned version of [mrm8488/electricidad-small-discriminator](https://huggingface.co/mrm8488/electricidad-small-discriminator) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0458
-- Accuracy: 0.9916 
-## Model description
-More information needed
-## Intended uses & limitations
-More information needed
-## Training and evaluation data
-More information needed
-## Training procedure
-### Training hyperparameters
-The following hyperparameters were used during training:
+El presente modelo se encentra basado en na versión mejorada de [mrm8488/electricidad-small-discriminator](https://huggingface.co/mrm8488/electricidad-small-discriminator), y con el uso de la base de datos [hackathon-pln-es/comentarios_depresivos](https://huggingface.co/datasets/hackathon-pln-es/comentarios_depresivos).
+Siendo de esta manera los resultados obtenidos en la evaluación del modelo:
+- Pérdida 0.0458
+- Precisión: 0.9916 
+## Autores
+- Danny Vásquez
+- César Salazar
+- Alexis Cañar
+- Yannela Castro
+- Daniel Patiño
+## Descripción del Modelo
+electricidad-small-discriminator-finetuned-clasificacion-comentarios-suicidas es un modelo Transformers pre-entrenado bajo un largo corpus de comentarios obtenidos de REEDIT traducidos al español, con el fin de poder predecir si un comentario tiene una tendencia suicida en base al contexto. Por ende, recibirá una ENTRADA en la cuál se ingresará el texto a comprobar, para posteriormente obtener como única SALIDA de igual manera dos posibles opciones: “Suicida” o “No Suicida”. 
+## Motivación
+Siendo la principal inspiración del modelo que sea utilizado para futuros proyectos que busquen detectar los casos de depresión a tiempo mediante el procesamiento del lenguaje natural, para poder prevenir los casos de suicido en niños, jóvenes y adultos.
+
+## ¿Cómo usarlo?
+
+El modelo puede ser utilizado de manera directa mediante la importación de la librería pipeline de transformers:
+
+```python
+>>> from transformers import pipeline
+>>> model_name= 'hackathon-pln-es/electricidad-small-discriminator-finetuned-clasificacion-comentarios-suicidas'
+>>> cls= pipeline("text-classification", model=model_name)
+>>> cls(“Estoy feliz”)[0]['label']
+[{'resultado': "No Suicida"
+}]
+>>> cls(“Quiero acabar con todo”)[0]['label']
+[{'resultado': " Suicida"
+}]
+```
+## Proceso de entrenamiento
+### Datos de entrenamiento
+Como se declaró anteriormente, el modelo se pre-entrenó basándose en la base de datos [comentarios_depresivos]( https://huggingface.co/datasets/hackathon-pln-es/comentarios_depresivos), el cuál posee una cantidad de 192 347 filas de datos para el entrenamiento, 33 944 para las pruebas y 22630 para la validación.
+### Hiper parámetros de entrenamiento
 - learning_rate: 2e-05
 - train_batch_size: 32
 - eval_batch_size: 32
 - lr_scheduler_type: linear
 - num_epochs: 15
-### Training results
-| Training Loss | Epoch | Validation Loss | Accuracy |
+
+### Resultados del entrenamiento
+| Pérdida_entrenamiento | Epoch | Pérdida_Validación | Presición |
 |:-------------:|:-----:|:---------------:|:--------:|
 | 0.161100       | 1.0   | 0.133057         | 0.952718 |
 | 0.134500        | 2.0   | 0.110966       | 0.960804 |
@@ -64,11 +92,30 @@ The following hyperparameters were used during training:
 | 0.028400        | 14.0   | 0.045003        | 0.991869 |
 | 0.022300        | 15.0   | 0.045819        | 0.991648 |
 
-
-### Framework versions
+### Versiones del Framework
 - Transformers 4.17.0
 - Pytorch 1.10.0+cu111
 - Datasets 2.0.0
 - Tokenizers 0.11.6
 
+## Citación BibTeX
+
+```bibtex
+@article{ccs_2022,
+  author    = {Danny Vásquez and
+               César Salazar and
+               Alexis Cañar and
+               Yannela Castro and
+Daniel Patiño},
+  title     = {Modelo Electricidad-small-discriminator-finetuned-clasificacion-comentarios-suicidas},
+  journal   = {Huggingface},
+  year      = {2022},
+}
+```
+
+<a href="https://huggingface.co/spaces/hackathon-pln-es/clasificador-comentarios-suicidas">
+<p> Visualizar en GRADIO</p>	
+<img width="300px" src="https://hf.space/embed/hackathon-pln-es/clasificador-comentarios-suicidas/static/img/logo.svg">
+</a>
 ---
+