maes / README.md
yazidtagnaouti's picture
Push model using huggingface_hub.
e9d69f9 verified
|
raw
history blame
No virus
16.6 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.9666666666666667
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 |
|:------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 14 | <ul><li>'Salut, tout le monde va bien ?'</li><li>'Salut, ça va bien ?'</li><li>'Bonne journée!'</li></ul> |
| 11 | <ul><li>"Quelle est la politique de la banque CDM en cas de défaut de paiement ou de retard dans les contributions à un plan d'épargne éducation?"</li><li>"Est-il possible de nommer un bénéficiaire supplémentaire ou de modifier le bénéficiaire désigné pour un plan d'épargne éducation chez la banque CDM?"</li><li>"Quels sont les différents niveaux de risque associés aux produits d'épargne éducation proposés par la banque CDM?"</li></ul> |
| 1 | <ul><li>"Y a-t-il des conditions spécifiques à respecter pour bénéficier des avantages de l'assurance épargne?"</li><li>"Quels sont les avantages fiscaux associés à la souscription d'une assurance épargne chez CDM?"</li><li>"Est-ce que l'assurance épargne chez CDM offre des options de transfert automatique de fonds depuis mon compte courant ou d'autres comptes?"</li></ul> |
| 8 | <ul><li>'Un prêt à la consommation serait idéal pour couvrir les frais médicaux non prévus.'</li><li>"Je recherche des options de financement pour un voyage et je m'intéresse à un prêt à la consommation."</li><li>'quels sont les avantages du credit a la consommation'</li></ul> |
| 0 | <ul><li>'Quels sont les coûts associés à cette assurance, et comment sont-ils facturés?'</li><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>'Proposez-vous des assurances décès et invalidité chez CDM?'</li></ul> |
| 16 | <ul><li>"Quels types de protections en cas d'accident proposez-vous?"</li><li>"Puis-je transférer ma protection en cas d'accident si je change de véhicule ou de situation?"</li><li>"Quels sont les documents nécessaires en cas de déclaration d'accident pour bénéficier de la couverture?"</li></ul> |
| 2 | <ul><li>"Quels types de pertes ou de dommages sont couverts par l'assurance des moyens de paiement?"</li><li>"Existe-t-il des options de couverture supplémentaires que je peux ajouter à mon contrat d'assurance des moyens de paiement ?"</li><li>"Quelle est la période de couverture de l'assurance des moyens de paiement?"</li></ul> |
| 13 | <ul><li>"C'était utile, merci!"</li><li>"C'était informatif, au revoir!"</li><li>'BY'</li></ul> |
| 12 | <ul><li>'Est-ce que la banque CDM offre des services de conseil financier pour aider les clients à planifier leur retraite?'</li><li>'Y a-t-il des incitations spéciales pour les jeunes travailleurs ou les personnes qui commencent à épargner tôt pour leur retraite?'</li><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></ul> |
| 7 | <ul><li>"Y a-t-il des frais supplémentaires associés à l'obtention d'un crédit auto, comme les frais de traitement du dossier?"</li><li>"Est-ce que CDM propose des prêts auto pour les véhicules d'occasion ?"</li><li>"Quelle est la durée typique d'un prêt automobile chez CDM?"</li></ul> |
| 4 | <ul><li>'Quels services puis-je effectuer en ligne, tels que le virement de fonds ou le paiement de factures?'</li><li>'Quelle est la politique de la banque CDM en matière de protection de la vie privée pour les services bancaires en ligne?'</li><li>"Comment puis-je m'inscrire pour les services de banque en ligne de CDM?"</li></ul> |
| 5 | <ul><li>'Quelle est la politique de remboursement en cas de fraude sur ma carte bancaire?'</li><li>'Comment fonctionne le processus de renouvellement de ma carte bancaire expirée?'</li><li>"Quels sont les critères d'admissibilité pour obtenir une carte de crédit chez CDM?"</li></ul> |
| 10 | <ul><li>"quels types de comptes d'epargne proposez vous"</li><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 régulière est une habitude financière saine qui peut apporter une tranquillité d'esprit à long terme."</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>'Comment puis-je contacter le service de gestion des dépôts à terme de la banque CDM pour ouvrir un nouveau compte ?'</li><li>"Où puis-je trouver les coordonnées du service de gestion des transferts internationaux de la banque CDM pour effectuer des virements à l'étranger ?"</li></ul> |
| 9 | <ul><li>'Je veux un crédit pour acheter une maison'</li><li>"La banque CDM offre-t-elle des conseils ou des services d'accompagnement pour les nouveaux propriétaires immobiliers?"</li><li>"Quels sont les avantages ou les programmes spéciaux liés à l'obtention d'un crédit immobilier chez la banque CDM?"</li></ul> |
| 17 | <ul><li>"Y a-t-il des frais associés à la réalisation d'une simulation de crédit chez la banque CDM?"</li><li>'Puis-je réaliser une simulation de crédit pour un prêt personnel, un crédit auto et un crédit immobilier en même temps chez la banque CDM?'</li><li>'Existe-t-il une assistance disponible pour comprendre les résultats de la simulation de crédit chez la banque CDM?'</li></ul> |
| 3 | <ul><li>'assurance habitation'</li><li>"Est-ce que l'assurance multirisques habitation couvre les dommages causés par des catastrophes naturelles?"</li><li>"Quels sont les délais de traitement des demandes de remboursement en cas de sinistre avec l'assurance multirisques habitation de la banque CDM?"</li></ul> |
| 15 | <ul><li>'Quelles sont les options de gestion de compte en ligne disponibles?'</li><li>'je desire creer un compte chez vous'</li><li>"Comment puis-je transférer mes comptes existants d'une autre banque vers CDM?"</li></ul> |
## Evaluation
### Metrics
| Label | Accuracy |
|:--------|:---------|
| **all** | 0.9667 |
## 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.5053 | 28 |
| Label | Training Sample Count |
|:------|:----------------------|
| 0 | 16 |
| 1 | 16 |
| 2 | 16 |
| 3 | 16 |
| 4 | 16 |
| 5 | 16 |
| 6 | 15 |
| 7 | 16 |
| 8 | 16 |
| 9 | 16 |
| 10 | 15 |
| 11 | 16 |
| 12 | 16 |
| 13 | 16 |
| 14 | 16 |
| 15 | 16 |
| 16 | 16 |
| 17 | 15 |
### 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
- max_length: 256
- seed: 42
- eval_max_steps: -1
- load_best_model_at_end: True
### Training Results
| Epoch | Step | Training Loss | Validation Loss |
|:-------:|:-------:|:-------------:|:---------------:|
| 0.0014 | 1 | 0.1659 | - |
| 0.0701 | 50 | 0.044 | - |
| 0.1403 | 100 | 0.0374 | - |
| 0.2104 | 150 | 0.0624 | - |
| 0.2805 | 200 | 0.005 | - |
| 0.3506 | 250 | 0.0022 | - |
| 0.4208 | 300 | 0.0042 | - |
| 0.4909 | 350 | 0.0012 | - |
| 0.5610 | 400 | 0.0016 | - |
| 0.6311 | 450 | 0.001 | - |
| 0.7013 | 500 | 0.0006 | - |
| 0.7714 | 550 | 0.0006 | - |
| 0.8415 | 600 | 0.0009 | - |
| 0.9116 | 650 | 0.0005 | - |
| 0.9818 | 700 | 0.0006 | - |
| **1.0** | **713** | **-** | **0.0202** |
* 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.*
-->