maes / README.md
yazidtagnaouti's picture
Push model using huggingface_hub.
efe07ea verified
|
raw
history blame
No virus
17.3 kB
---
library_name: setfit
tags:
- setfit
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
metrics:
- accuracy
widget:
- text: Quelle est la durée typique d'un prêt auto chez la banque CDM?
- text: Y a-t-il des services d'assistance supplémentaires inclus dans l'assurance
décès et invalidité, tels que des conseils juridiques ou financiers en cas de
besoin?
- text: Y a-t-il des restrictions quant au montant maximum couvert par l'assurance
des moyens de paiement ?
- text: Est-il possible de réaliser une simulation de crédit pour différents montants
et durées de prêt chez la banque CDM?
- text: Quels sont les avantages liés à l'utilisation d'une carte de crédit plutôt
qu'une carte de débit?
pipeline_tag: text-classification
inference: true
base_model: Sahajtomar/french_semantic
model-index:
- name: SetFit with Sahajtomar/french_semantic
results:
- task:
type: text-classification
name: Text Classification
dataset:
name: Unknown
type: unknown
split: test
metrics:
- type: accuracy
value: 0.9111111111111111
name: Accuracy
---
# SetFit with Sahajtomar/french_semantic
This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [Sahajtomar/french_semantic](https://huggingface.co/Sahajtomar/french_semantic) as the Sentence Transformer embedding model. A [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance is used for classification.
The model has been trained using an efficient few-shot learning technique that involves:
1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
2. Training a classification head with features from the fine-tuned Sentence Transformer.
## Model Details
### Model Description
- **Model Type:** SetFit
- **Sentence Transformer body:** [Sahajtomar/french_semantic](https://huggingface.co/Sahajtomar/french_semantic)
- **Classification head:** a [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance
- **Maximum Sequence Length:** 514 tokens
- **Number of Classes:** 18 classes
<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
<!-- - **Language:** Unknown -->
<!-- - **License:** Unknown -->
### Model Sources
- **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
- **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
- **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
### Model Labels
| Label | Examples |
|:------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 3 | <ul><li>'Quelle est la procédure en cas de sinistre, et comment puis-je déposer une réclamation?'</li><li>"Est-ce que l'assurance multirisques habitation couvre les dommages causés par des catastrophes naturelles?"</li><li>"Quels critères sont pris en compte pour déterminer le montant de la prime d'assurance multirisques habitation chez la banque CDM?"</li></ul> |
| 6 | <ul><li>"J'aimerais savoir comment joindre le service de planification financière de la banque CDM pour discuter de mes objectifs financiers à long terme."</li><li>"Où puis-je trouver les coordonnées du service d'assistance technique de la banque CDM pour résoudre un problème avec mon application mobile ?"</li><li>"Où puis-je trouver les coordonnées du service de prêt immobilier de la banque CDM pour obtenir des informations sur les taux d'intérêt ?"</li></ul> |
| 11 | <ul><li>"Comment puis-je accéder à des relevés ou à des rapports détaillés sur l'activité de mon compte d'épargne éducation chez la banque CDM?"</li><li>"Quels sont les produits d'épargne éducation proposés par la banque CDM?"</li><li>"Quels sont les critères d'éligibilité pour souscrire à un plan d'épargne éducation?"</li></ul> |
| 10 | <ul><li>"Je suis à la recherche de conseils sur la constitution d'un fonds d'urgence pour faire face aux dépenses imprévues."</li><li>"L'épargne peut également servir à financer des projets personnels, comme des voyages ou des études supérieures."</li><li>"L'épargne régulière est un moyen efficace de réaliser des objectifs financiers à long terme."</li></ul> |
| 2 | <ul><li>"Quelles sont les démarches à suivre pour déposer une réclamation auprès de l'assureur en cas de besoin ?"</li><li>'assurance moy de paiement'</li><li>"Est-ce que l'assurance des moyens de paiement inclut une assistance en cas de fraude ou d'utilisation non autorisée de mes cartes ?"</li></ul> |
| 17 | <ul><li>"Comment puis-je ajuster les paramètres de ma simulation de crédit pour voir l'impact sur les mensualités et le coût total du prêt?"</li><li>"Comment puis-je accéder à l'outil de simulation de crédit en ligne de la banque CDM?"</li><li>'Quelles informations personnelles sont nécessaires pour effectuer une simulation de crédit en ligne chez la banque CDM?'</li></ul> |
| 8 | <ul><li>'Je suis intéressé par un prêt à la consommation pour financer des dépenses imprévues.'</li><li>'Comment puis-je demander un crédit à la consommation chez CDM?'</li><li>"J'envisage de souscrire un prêt à la consommation afin de financer mes études."</li></ul> |
| 0 | <ul><li>"Quels documents ou informations supplémentaires sont nécessaires lors de la souscription à l'assurance décès et invalidité chez la banque CDM?"</li><li>"Quelle est la procédure en cas de changement de situation personnelle ou professionnelle qui pourrait affecter ma couverture d'assurance?"</li><li>"Est-ce que l'assurance décès et invalidité offre une protection pour les prêts contractés auprès de la banque CDM, tels que les prêts hypothécaires ou les prêts auto?"</li></ul> |
| 14 | <ul><li>'Bonne journée!'</li><li>'Salam!'</li><li>'Bonsoir, comment ça va ?'</li></ul> |
| 9 | <ul><li>'Je veux un crédit pour acheter une maison'</li><li>"Quelles sont les conditions d'éligibilité pour obtenir un prêt immobilier?"</li><li>'Mon projet consiste à contracter un prêt immobilier pour investir dans une propriété résidentielle.'</li></ul> |
| 5 | <ul><li>'Comment fonctionne le processus de renouvellement de ma carte bancaire expirée?'</li><li>"Y a-t-il des programmes de fidélité spécifiques aux commerçants associés à l'utilisation de ma carte bancaire CDM?"</li><li>"Est-il possible de transférer le solde d'une carte de crédit externe vers une carte de crédit CDM?"</li></ul> |
| 7 | <ul><li>'Est-ce que la banque CDM propose des offres spéciales ou des taux préférentiels pour certains véhicules?'</li><li>'je veux financer ma nouvelle voiture'</li><li>'Je souhaite obtenir un crédit auto afin de remplacer mon véhicule actuel.'</li></ul> |
| 1 | <ul><li>"Y a-t-il des limitations sur le nombre de retraits que je peux effectuer sur mon compte d'assurance épargne pendant une période donnée?"</li><li>"Quels sont les avantages fiscaux associés à la souscription d'une assurance épargne chez CDM?"</li><li>"Puis-je résilier ou modifier ma police d'assurance épargne, et quelles sont les implications?"</li></ul> |
| 13 | <ul><li>"Je reviendrai si j'ai d'autres questions."</li><li>'bye'</li><li>'À bientôt!'</li></ul> |
| 16 | <ul><li>"Est-ce que la protection en cas d'accident couvre également les dommages matériels causés à des biens tiers?"</li><li>"Quelle est la période de validité de la protection en cas d'accident?"</li><li>"Quels sont les documents nécessaires en cas de déclaration d'accident pour bénéficier de la couverture?"</li></ul> |
| 15 | <ul><li>'quels types de comptes proposez vous?'</li><li>"Quelle est la politique de la banque CDM en matière de dépôt initial pour l'ouverture d'un compte?"</li><li>"Quels sont les avantages de l'ouverture d'un compte professionnel chez CDM par rapport à d'autres institutions financières?"</li></ul> |
| 12 | <ul><li>"Quelles sont les conséquences fiscales si je décide de transférer mon plan d'épargne retraite vers une autre institution financière?"</li><li>"Quels sont les avantages de souscrire à un produit d'épargne retraite chez la banque CDM?"</li><li>"Quels sont les frais associés à la souscription et à la gestion d'un plan d'épargne retraite?"</li></ul> |
| 4 | <ul><li>"Pouvez-vous m'expliquer le processus de sécurité mis en place pour les opérations bancaires en ligne?"</li><li>'Comment puis-je modifier mes informations personnelles ou mes préférences en ligne?'</li><li>'Quels services puis-je effectuer en ligne, tels que le virement de fonds ou le paiement de factures?'</li></ul> |
## Evaluation
### Metrics
| Label | Accuracy |
|:--------|:---------|
| **all** | 0.9111 |
## Uses
### Direct Use for Inference
First install the SetFit library:
```bash
pip install setfit
```
Then you can load this model and run inference.
```python
from setfit import SetFitModel
# Download from the 🤗 Hub
model = SetFitModel.from_pretrained("yazidtagnaouti/maes")
# Run inference
preds = model("Quelle est la durée typique d'un prêt auto chez la banque CDM?")
```
<!--
### Downstream Use
*List how someone could finetune this model on their own dataset.*
-->
<!--
### Out-of-Scope Use
*List how the model may foreseeably be misused and address what users ought not to do with the model.*
-->
<!--
## Bias, Risks and Limitations
*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
-->
<!--
### Recommendations
*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
-->
## Training Details
### Training Set Metrics
| Training set | Min | Median | Max |
|:-------------|:----|:--------|:----|
| Word count | 1 | 14.4563 | 28 |
| Label | Training Sample Count |
|:------|:----------------------|
| 0 | 14 |
| 1 | 14 |
| 2 | 14 |
| 3 | 14 |
| 4 | 14 |
| 5 | 14 |
| 6 | 14 |
| 7 | 14 |
| 8 | 14 |
| 9 | 14 |
| 10 | 14 |
| 11 | 14 |
| 12 | 14 |
| 13 | 14 |
| 14 | 14 |
| 15 | 14 |
| 16 | 14 |
| 17 | 14 |
### Training Hyperparameters
- batch_size: (16, 2)
- num_epochs: (1, 16)
- max_steps: -1
- sampling_strategy: oversampling
- num_iterations: 20
- body_learning_rate: (2e-05, 1e-05)
- head_learning_rate: 0.01
- loss: CosineSimilarityLoss
- distance_metric: cosine_distance
- margin: 0.25
- end_to_end: True
- use_amp: False
- warmup_proportion: 0.1
- seed: 42
- eval_max_steps: -1
- load_best_model_at_end: True
### Training Results
| Epoch | Step | Training Loss | Validation Loss |
|:-------:|:-------:|:-------------:|:---------------:|
| 0.0016 | 1 | 0.1462 | - |
| 0.0794 | 50 | 0.0687 | - |
| 0.1587 | 100 | 0.0139 | - |
| 0.2381 | 150 | 0.0034 | - |
| 0.3175 | 200 | 0.0139 | - |
| 0.3968 | 250 | 0.002 | - |
| 0.4762 | 300 | 0.0016 | - |
| 0.5556 | 350 | 0.0009 | - |
| 0.6349 | 400 | 0.0009 | - |
| 0.7143 | 450 | 0.0007 | - |
| 0.7937 | 500 | 0.0008 | - |
| 0.8730 | 550 | 0.0009 | - |
| 0.9524 | 600 | 0.0007 | - |
| **1.0** | **630** | **-** | **0.0276** |
* The bold row denotes the saved checkpoint.
### Framework Versions
- Python: 3.10.12
- SetFit: 1.0.3
- Sentence Transformers: 2.3.1
- Transformers: 4.35.2
- PyTorch: 2.1.0+cu121
- Datasets: 2.17.0
- Tokenizers: 0.15.1
## Citation
### BibTeX
```bibtex
@article{https://doi.org/10.48550/arxiv.2209.11055,
doi = {10.48550/ARXIV.2209.11055},
url = {https://arxiv.org/abs/2209.11055},
author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
title = {Efficient Few-Shot Learning Without Prompts},
publisher = {arXiv},
year = {2022},
copyright = {Creative Commons Attribution 4.0 International}
}
```
<!--
## Glossary
*Clearly define terms in order to be accessible across audiences.*
-->
<!--
## Model Card Authors
*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
-->
<!--
## Model Card Contact
*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
-->