Commit
·
a24c21d
1
Parent(s):
202f0ae
Update README.md
Browse files
README.md
CHANGED
@@ -8,88 +8,28 @@ metrics:
|
|
8 |
- f1
|
9 |
pipeline_tag: text-classification
|
10 |
---
|
11 |
-
# Model Card for Model ID
|
12 |
|
13 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
14 |
|
15 |
-
|
16 |
-
We used the dataset from [](). For this model we combine the original validation and test set, combine them, and re-splitted them into
|
17 |
-
## Model Details
|
18 |
|
19 |
-
|
20 |
|
21 |
-
|
22 |
|
|
|
23 |
|
|
|
24 |
|
25 |
-
- **Developed by:** [More Information Needed]
|
26 |
-
- **Shared by [optional]:** [More Information Needed]
|
27 |
-
- **Model type:** [More Information Needed]
|
28 |
-
- **Language(s) (NLP):** [More Information Needed]
|
29 |
-
- **License:** [More Information Needed]
|
30 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
31 |
|
32 |
-
|
|
|
|
|
|
|
|
|
33 |
|
34 |
-
|
35 |
-
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
|
40 |
-
## Uses
|
41 |
-
|
42 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
43 |
-
|
44 |
-
### Direct Use
|
45 |
-
|
46 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
47 |
-
|
48 |
-
[More Information Needed]
|
49 |
-
|
50 |
-
### Downstream Use [optional]
|
51 |
-
|
52 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
53 |
-
|
54 |
-
[More Information Needed]
|
55 |
-
|
56 |
-
### Out-of-Scope Use
|
57 |
-
|
58 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
59 |
-
|
60 |
-
[More Information Needed]
|
61 |
-
|
62 |
-
## Bias, Risks, and Limitations
|
63 |
-
|
64 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
65 |
-
|
66 |
-
[More Information Needed]
|
67 |
-
|
68 |
-
### Recommendations
|
69 |
-
|
70 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
71 |
-
|
72 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
73 |
-
|
74 |
-
## How to Get Started with the Model
|
75 |
-
|
76 |
-
Use the code below to get started with the model.
|
77 |
-
|
78 |
-
[More Information Needed]
|
79 |
-
|
80 |
-
## Training Details
|
81 |
-
|
82 |
-
### Training Data
|
83 |
-
|
84 |
-
<!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
85 |
-
|
86 |
-
[More Information Needed]
|
87 |
-
|
88 |
-
### Training Procedure
|
89 |
-
|
90 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
|
|
8 |
- f1
|
9 |
pipeline_tag: text-classification
|
10 |
---
|
|
|
11 |
|
|
|
12 |
|
13 |
+
# Emotion English DistilRoBERTa-base
|
|
|
|
|
14 |
|
15 |
+
# Description ℹ
|
16 |
|
17 |
+
With this model, you can classify if an English sentence has a *Shakespearean* style or a *modern* style
|
18 |
|
19 |
+
The model is a fine-tuned checkpoint of [DistilRoBERTa-base](https://huggingface.co/distilroberta-base).
|
20 |
|
21 |
+
# Application 🚀
|
22 |
|
|
|
|
|
|
|
|
|
|
|
|
|
23 |
|
24 |
+
```python
|
25 |
+
from transformers import pipeline
|
26 |
+
classifier = pipeline("text-classification", model="notaphoenix/shakespeare_classifier_model", top_k=None)
|
27 |
+
classifier("This is a modern sentence!")
|
28 |
+
```
|
29 |
|
30 |
+
```json
|
31 |
+
[[
|
32 |
+
{'label': 'modern', 'score': 0.901931643486023},
|
33 |
+
{'label': 'shakespearean', 'score': 0.09806833416223526}
|
34 |
+
]]
|
35 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|