Update README.md

README.md

@@ -22,19 +22,19 @@ model-index:
     - name: Accuracy
       type: accuracy
       value: 0.9321428571428572
-    widget:
-    - text: 'Can I track the card you sent to me? '
-      example_title: Card Arrival Example - English
-    - text: 'Posso tracciare la carta che mi avete spedito? '
-      example_title: Card Arrival Example - Italian
-    - text: Can you explain your exchange rate policy to me?
-      example_title: Exchange Rate Example - English
-    - text: Potete spiegarmi la vostra politica dei tassi di cambio?
-      example_title: Exchange Rate Example - Italian
-    - text: I can't pay by my credit card
-      example_title: Card Not Working Example - English
-    - text: Non posso pagare con la mia carta di credito
-      example_title: Card Not Working Example - Italian
+widget:
+  - text: 'Can I track the card you sent to me? '
+    example_title: Card Arrival Example - English
+  - text: 'Posso tracciare la carta che mi avete spedito? '
+    example_title: Card Arrival Example - Italian
+  - text: Can you explain your exchange rate policy to me?
+    example_title: Exchange Rate Example - English
+  - text: Potete spiegarmi la vostra politica dei tassi di cambio?
+    example_title: Exchange Rate Example - Italian
+  - text: I can't pay by my credit card
+    example_title: Card Not Working Example - English
+  - text: Non riesco a pagare con la mia carta di credito
+    example_title: Card Not Working Example - Italian
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -54,14 +54,103 @@ More information needed
 
 ## Intended uses & limitations
 
-More information needed
+The model can be used on text classification. In particular is fine tuned on banking domain.
 
 ## Training and evaluation data
 
-More information needed
+The dataset used is [banking77](https://huggingface.co/datasets/banking77)
+
+The 77 labels are:
+
+|label|intent|
+|:---:|:----:|
+|0|activate_my_card|
+|1|age_limit|
+|2|apple_pay_or_google_pay|
+|3|atm_support|
+|4|automatic_top_up|
+|5|balance_not_updated_after_bank_transfer|
+|6|balance_not_updated_after_cheque_or_cash_deposit|
+|7|beneficiary_not_allowed|
+|8|cancel_transfer|
+|9|card_about_to_expire|
+|10|card_acceptance|
+|11|card_arrival|
+|12|card_delivery_estimate|
+|13|card_linking|
+|14|card_not_working|
+|15|card_payment_fee_charged|
+|16|card_payment_not_recognised|
+|17|card_payment_wrong_exchange_rate|
+|18|card_swallowed|
+|19|cash_withdrawal_charge|
+|20|cash_withdrawal_not_recognised|
+|21|change_pin|
+|22|compromised_card|
+|23|contactless_not_working|
+|24|country_support|
+|25|declined_card_payment|
+|26|declined_cash_withdrawal|
+|27|declined_transfer|
+|28|direct_debit_payment_not_recognised|
+|29|disposable_card_limits|
+|30|edit_personal_details|
+|31|exchange_charge|
+|32|exchange_rate|
+|33|exchange_via_app|
+|34|extra_charge_on_statement|
+|35|failed_transfer|
+|36|fiat_currency_support|
+|37|get_disposable_virtual_card|
+|38|get_physical_card|
+|39|getting_spare_card|
+|40|getting_virtual_card|
+|41|lost_or_stolen_card|
+|42|lost_or_stolen_phone|
+|43|order_physical_card|
+|44|passcode_forgotten|
+|45|pending_card_payment|
+|46|pending_cash_withdrawal|
+|47|pending_top_up|
+|48|pending_transfer|
+|49|pin_blocked|
+|50|receiving_money|
+|51|Refund_not_showing_up|
+|52|request_refund|
+|53|reverted_card_payment?|
+|54|supported_cards_and_currencies|
+|55|terminate_account|
+|56|top_up_by_bank_transfer_charge|
+|57|top_up_by_card_charge|
+|58|top_up_by_cash_or_cheque|
+|59|top_up_failed|
+|60|top_up_limits|
+|61|top_up_reverted|
+|62|topping_up_by_card|
+|63|transaction_charged_twice|
+|64|transfer_fee_charged|
+|65|transfer_into_account|
+|66|transfer_not_received_by_recipient|
+|67|transfer_timing|
+|68|unable_to_verify_identity|
+|69|verify_my_identity|
+|70|verify_source_of_funds|
+|71|verify_top_up|
+|72|virtual_card_not_working|
+|73|visa_or_mastercard|
+|74|why_verify_identity|
+|75|wrong_amount_of_cash_received|
+|76|wrong_exchange_rate_for_cash_withdrawal|
+
 
 ## Training procedure
 
+```
+from transformers import pipeline
+pipe = pipeline("text-classification", model="nickprock/xlm-roberta-base-banking77-classification")
+pipe("Non riesco a pagare con la carta di credito")
+```
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training: