Reggie commited on
Commit
fbb44ff
·
1 Parent(s): ab5d39c

Update README.md

Browse files

Add a not-a-joke example.

Files changed (1) hide show
  1. README.md +6 -3
README.md CHANGED
@@ -4,14 +4,17 @@ language:
4
  - en
5
  widget:
6
  - text: "A nervous passenger is about to book a flight ticket, and he asks the airlines' ticket seller, 'I hope your planes are safe. Do they have a good track record for safety?' The airline agent replies, 'Sir, I can guarantee you, we've never had a plane that has crashed more than once.'"
 
 
 
7
  ---
8
 
9
  ### What is this?
10
- A detector based on Facebook's [RoBerta-MUPPET](https://huggingface.co/facebook/muppet-roberta-base) to detect "narrative-style" jokes, stories and anecdotes i.e. they are narrated as a story. See the example in the inference widget or How to use section.
11
 
12
- This has not been trained or tested on one-liners, puns or Reddit-style language-manipulation jokes such as knock-knock, Q&A jokes etc.
13
 
14
- This model has been developed to detect jokes & anecdotes spoken during speeches or conversations etc.
15
 
16
  ### Install these first
17
  You'll need to pip install transformers & maybe sentencepiece
 
4
  - en
5
  widget:
6
  - text: "A nervous passenger is about to book a flight ticket, and he asks the airlines' ticket seller, 'I hope your planes are safe. Do they have a good track record for safety?' The airline agent replies, 'Sir, I can guarantee you, we've never had a plane that has crashed more than once.'"
7
+ example_title: "A joke"
8
+ - text: "On a shelf, there are five books: a gray book, a red book, a purple book, a blue book, and a black book."
9
+ example_title: "Not a joke"
10
  ---
11
 
12
  ### What is this?
13
+ This model has been developed to detect "narrative-style" jokes, stories and anecdotes (i.e. they are narrated as a story) spoken during speeches or conversations etc. It is based on Facebook's [RoBerta-MUPPET](https://huggingface.co/facebook/muppet-roberta-base).
14
 
15
+ This model has not been trained or tested on one-liners, puns or Reddit-style language-manipulation jokes such as knock-knock, Q&A jokes etc.
16
 
17
+ See the example in the inference widget or How to use section for what constitues a narrative-style joke.
18
 
19
  ### Install these first
20
  You'll need to pip install transformers & maybe sentencepiece