Update README.md

README.md

@@ -10,6 +10,12 @@ metrics:
 model-index:
 - name: bert-base-spanish-analysis-app-questions
   results: []
+license: mit
+datasets:
+- devdroide/MiFirma-Ejemplo
+language:
+- es
+pipeline_tag: text-classification
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -17,7 +23,7 @@ should probably proofread and complete it, then remove this comment. -->
 
 # bert-base-spanish-analysis-app-questions
 
-This model is a fine-tuned version of [dccuchile/bert-base-spanish-wwm-uncased](https://huggingface.co/dccuchile/bert-base-spanish-wwm-uncased) on an unknown dataset.
+This model is a fine-tuned version of [dccuchile/bert-base-spanish-wwm-uncased](https://huggingface.co/dccuchile/bert-base-spanish-wwm-uncased) on an [devdroide/MiFirma-Ejemplo](https://huggingface.co/datasets/devdroide/MiFirma-Ejemplo) dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.0004
 - Accuracy: 1.0
@@ -27,17 +33,31 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
+This model was fine-tuned for question classification in a fictitious app. List label from dataset:
+
+*  informacion_aplicacion
+*  Perfiles
+*  Perfil_adminsitrador
+*  Perfil_cliente
+*  Procesos
+*  Productos
+*  Personas_Firmantes
+*  Error_324
+*  Error_339
+*  Error_507
+*  Error_532
+*  Error_517
+*  Error_517_06
+*  Error_517_10
+*  Error_517_45
+*  Error_517_1120
+*  Error_301
+
+### num_labels: 17
 
 ## Training and evaluation data
 
-More information needed
-
-## Training procedure
+Set of frequently asked questions for an application. The set of questions consists of approximately 680 questions in Spanish. The set has the split of training, validation and testing.
 
 ### Training hyperparameters
 
@@ -72,3 +92,58 @@ The following hyperparameters were used during training:
 - Pytorch 2.3.1+cu121
 - Datasets 2.20.0
 - Tokenizers 0.19.1
+
+## Demo - Basic Usage
+
+```python
+# Colab
+
+!pip install transformers
+
+name_model = "devdroide/bert-base-spanish-analysis-app-questions"
+
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+tokenizer = AutoTokenizer.from_pretrained(name_model)
+model = AutoModelForSequenceClassification.from_pretrained(name_model)
+
+def classify_question(question):
+    inputs = tokenizer(question, padding=True, truncation=True, return_tensors="pt")
+    outputs = model(**inputs)
+    predictions = outputs.logits.argmax(dim=-1)
+    list_label = ['informacion_aplicacion', 'Perfiles', 'Perfil_adminsitrador', 'Perfil_cliente', 'Procesos', 'Productos', 'Personas_Firmantes', 'Error_324', 'Error_339', 'Error_507', 'Error_532', 'Error_517', 'Error_517_06', 'Error_517_10', 'Error_517_45', 'Error_517_1120', 'Error_301']
+    return list_label[predictions.item()]
+
+questions = [
+    "¿Qué es mi firma?",
+    "Hola, Al cliente le salió en la aplicación el código de error 517:06 ¿Cuál es la recomendación?",
+    "Buenas tardes ¿En la herramienta que perfiles hay?",
+    "Buenos días, ¿Cuál es el listado de perfiles en la aplicación?",
+    "Buenas tardes al cliente le salió el error 517 06 ¿Cuál es la recomendación",
+    "Hola Tengo en la herramienta el código de error 517 ¿Cuál es la recomendación?",
+]
+
+for question in questions:
+    category = classify_question(question)
+    print(f"Question: {question}")
+    print(f"Predicted category: {category}\n")
+
+# Response example
+# Question: ¿Qué es mi firma?
+# Predicted category: informacion_aplicacion
+
+# uestion: Hola, Al cliente le salió en la aplicación el código de error 517:06 ¿Cuál es la recomendación?
+# Predicted category: Error_517_06
+
+# Question: Buenas tardes ¿En la herramienta que perfiles hay?
+# Predicted category: Perfiles
+
+# Question: Buenos días, ¿Cuál es el listado de perfiles en la aplicación?
+# Predicted category: Perfiles
+
+# Question: Buenas tardes al cliente le salió el error 517 06 ¿Cuál es la recomendación
+# Predicted category: Error_517_06
+
+# Question: Hola Tengo en la herramienta el código de error 517 ¿Cuál es la recomendación?
+# Predicted category: Error_517
+
+```