David Pollack commited on
Commit
d4753b5
1 Parent(s): c4334ac

add tags to readme

Browse files
Files changed (1) hide show
  1. README.md +25 -3
README.md CHANGED
@@ -1,6 +1,28 @@
1
- This is a dummy model that can be used for testing. It should always give random results (i.e. `{"label": "negative", "score": 0.5}`).
 
 
 
 
 
 
 
 
 
2
 
3
- It was created as follows:
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
5
  1. Create a vocab.txt file (in /tmp/vocab.txt in this example).
6
 
@@ -12,7 +34,7 @@ It was created as follows:
12
  [MASK]
13
  ```
14
 
15
- 2. Open a python shell and run the following
16
 
17
  ```python
18
  import transformers
 
1
+ ---
2
+ language:
3
+ - "multilingual"
4
+ - "en"
5
+ tags:
6
+ - "sentiment-analysis"
7
+ - "testing"
8
+ - "unit tests"
9
+ ---
10
+ # DistilBert Dummy Sentiment Model
11
 
12
+ ## Purpose
13
+
14
+ This is a dummy model that can be used for testing the transformers `pipeline` with the task `sentiment-analysis`. It should always give random results (i.e. `{"label": "negative", "score": 0.5}`).
15
+
16
+ ## How to use
17
+
18
+ ```python
19
+ classifier = pipeline("dhpollack/distilbert-dummy-sentiment")
20
+ results = classifier(["this is a test", "another test"])
21
+ ```
22
+
23
+ ## Notes
24
+
25
+ This was created as follows:
26
 
27
  1. Create a vocab.txt file (in /tmp/vocab.txt in this example).
28
 
 
34
  [MASK]
35
  ```
36
 
37
+ 2. Open a python shell:
38
 
39
  ```python
40
  import transformers