Jorge Lopez Grisman commited on
Commit
9f828b6
1 Parent(s): d91711a

Update README.md

Browse files

Adding changes on the read me.

Files changed (1) hide show
  1. README.md +22 -4
README.md CHANGED
@@ -2,6 +2,10 @@
2
  license: apache-2.0
3
  tags:
4
  - generated_from_trainer
 
 
 
 
5
  metrics:
6
  - accuracy
7
  - f1
@@ -15,7 +19,7 @@ should probably proofread and complete it, then remove this comment. -->
15
 
16
  # bert-base-uncased-finetuned-surveyclassification
17
 
18
- This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on the None dataset.
19
  It achieves the following results on the evaluation set:
20
  - Loss: 0.2818
21
  - Accuracy: 0.9097
@@ -25,13 +29,27 @@ It achieves the following results on the evaluation set:
25
 
26
  More information needed
27
 
28
- ## Intended uses & limitations
29
 
30
- More information needed
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
 
32
  ## Training and evaluation data
33
 
34
- More information needed
35
 
36
  ## Training procedure
37
 
 
2
  license: apache-2.0
3
  tags:
4
  - generated_from_trainer
5
+ language: en
6
+ widget:
7
+ - text: "i have been in contact today with the insurance at least 3 times the person i had originally spoken to eileen i believe her name was she was very helpful. the two reps i got after her didnaaaTMt help me solve the issue i was calling about at all. i have been playing middle man between my insurance and doctors office and i have been getting told two different things. all i wanted was for them to get in contact with each other about the issue simple as that. the last person i just spoke to was extremely rude. iaaaTMm very disappointed with the service provided today. iaaaTMm the one paying for the insurance i just wanted to be led in the right direction on what to do."
8
+ - text: "The agent on the phone was very helpful and nice to me."
9
  metrics:
10
  - accuracy
11
  - f1
 
19
 
20
  # bert-base-uncased-finetuned-surveyclassification
21
 
22
+ This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on a custom survey dataset.
23
  It achieves the following results on the evaluation set:
24
  - Loss: 0.2818
25
  - Accuracy: 0.9097
 
29
 
30
  More information needed
31
 
32
+ #### Limitations and bias
33
 
34
+ This model is limited by its training dataset of survey results for a particular customer service domain. This may not generalize well for all use cases in different domains.
35
+
36
+ #### How to use
37
+
38
+ You can use this model with Transformers *pipeline* for Text Classification.
39
+
40
+ ```python
41
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification, pipeline
42
+ tokenizer = AutoTokenizer.from_pretrained("Jorgeutd/bert-base-uncased-finetuned-surveyclassification")
43
+ model = AutoModelForSequenceClassification.from_pretrained("Jorgeutd/bert-base-uncased-finetuned-surveyclassification")
44
+ text_classifier = pipeline("text-classification", model=model,tokenizer=tokenizer, device=0)
45
+ example = "The agent on the phone was very helpful and nice to me."
46
+ results = text_classifier(example)
47
+ print(results)
48
+ ```
49
 
50
  ## Training and evaluation data
51
 
52
+ Custom survey dataset.
53
 
54
  ## Training procedure
55