Create README.md

README.md

@@ -1,22 +1,42 @@
-# EJEMPLO DE USO
+---
+language:
+- es
+base_model: cardiffnlp/twitter-roberta-base-sentiment-latest
+---
 
+# BERT Bregman - Modelo de Análisis de Sentimientos en Español
 
+Este modelo está basado en XLM-RoBERTa y ha sido fine-tuned para realizar análisis de sentimientos en textos en español.
 
-## Cargar librerías
+## Rendimiento del Modelo
 
-import torch
-from transformers import XLMRobertaForSequenceClassification, XLMRobertaTokenizer, AutoTokenizer
+•⁠  ⁠*Accuracy*: 0.7432
+•⁠  ⁠*F1 Score*: 0.7331
+•⁠  ⁠*Precision*: 0.7483
+•⁠  ⁠*Recall*: 0.7432
+
+### Métricas por Clase
 
-## Cargar el modelo y el tokenizador
-model_path = "nmarinnn/bert-bregman"
-model = XLMRobertaForSequenceClassification.from_pretrained(model_path)
-tokenizer = XLMRobertaTokenizer.from_pretrained(model_path)
-loaded_tokenizer = AutoTokenizer.from_pretrained(model_path)
+| Clase    | Precision | Recall | F1-Score | Support |
+|----------|-----------|--------|----------|---------|
+| Negativo | 0.8718    | 0.7234 | 0.7907   | 47      |
+| Neutro   | 0.0000    | 0.0000 | 0.0000   | 3       |
+| Positivo | 0.6000    | 0.8750 | 0.7119   | 24      |
 
-## Función para predecir etiqueta
+## Uso del Modelo
+
+Este modelo puede ser utilizado para clasificar el sentimiento de textos en español en tres categorías: negativo, neutro y positivo.
+
+⁠ python
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+import torch
+
+model_name = "nmarinnn/bert-bregman"
+model = AutoModelForSequenceClassification.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
 
 def predict(text):
-    inputs = loaded_tokenizer(text, return_tensors="pt", truncation=True, padding=True, max_length=512)
+    inputs = tokenizer(text, return_tensors="pt", truncation=True, padding=True, max_length=512)
     with torch.no_grad():
         outputs = model(**inputs)
     
@@ -24,14 +44,35 @@ def predict(text):
     predicted_class = torch.argmax(probabilities, dim=-1).item()
     
     class_labels = {0: "negativo", 1: "neutro", 2: "positivo"}
-    predicted_label = class_labels[predicted_class]
-    predicted_probability = probabilities[0][predicted_class].item()
-    
-    return predicted_label, predicted_probability, probabilities[0].tolist()
+    return class_labels[predicted_class]
 
 # Ejemplo de uso
-text_to_classify = "vamos rusa"
-predicted_label, predicted_prob, class_probabilities = predict(text_to_classify)
+texto = "Me encanta este producto, es excelente!"
+sentimiento = predict(texto)
+print(f"El sentimiento del texto es: {sentimiento}")
+ ⁠
+
+## Limitaciones
+
+•⁠  ⁠El modelo muestra un rendimiento bajo en la clase "neutro", posiblemente debido a un desbalance en el dataset de entrenamiento.
+•⁠  ⁠Se recomienda precaución al interpretar resultados para textos muy cortos o ambiguos.
+
+## Información de Entrenamiento
+
+•⁠  ⁠*Épocas*: 2
+•⁠  ⁠*Pasos de entrenamiento*: 148
+•⁠  ⁠*Pérdida de entrenamiento*: 0.6209
+
+## Cita
+
+Si utilizas este modelo en tu investigación, por favor cita:
+
 
-print(f"Clase predicha: {predicted_label} (probabilidad = {predicted_prob:.2f})")
-print(f"Probabilidades de todas las clases: Negativo: {class_probabilities[0]:.2f}, Neutro: {class_probabilities[1]:.2f}, Positivo: {class_probabilities[2]:.2f}")
+@misc{marinnn2023bertbregman,
+  author = {Marin, Natalia},
+  title = {BERT Bregman - Modelo de Análisis de Sentimientos en Español},
+  year = {2023},
+  publisher = {HuggingFace},
+  journal = {HuggingFace Model Hub},
+  howpublished = {\url{https://huggingface.co/nmarinnn/bert-bregman}}
+}