StevenTang commited on
Commit
7ba1019
1 Parent(s): 64ec495

Update README

Browse files
Files changed (1) hide show
  1. README.md +42 -0
README.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - text-generation
7
+ - text2text-generation
8
+ pipeline_tag: text2text-generation
9
+ widget:
10
+ - text: "Given the story title: I think all public schools should have a uniform dress code."
11
+ example_title: "Example1"
12
+ - text: "Given the story title: My girlfriend and I decided to move to a new state. We packed everything in our cars and drove there."
13
+ example_title: "Example2"
14
+ ---
15
+
16
+ # MVP-story
17
+ The MVP-story model was proposed in [**MVP: Multi-task Supervised Pre-training for Natural Language Generation**](https://github.com/RUCAIBox/MVP/blob/main/paper.pdf) by Tianyi Tang, Junyi Li, Wayne Xin Zhao and Ji-Rong Wen.
18
+
19
+ The detailed information and instructions can be found [https://github.com/RUCAIBox/MVP](https://github.com/RUCAIBox/MVP).
20
+
21
+ ## Model Description
22
+ MVP-story is a prompt-based model that MVP is further equipped with prompts pre-trained using labeled story generation datasets. It is a variant (MVP+S) of our main [MVP](https://huggingface.co/RUCAIBox/mvp) model. It follows a Transformer encoder-decoder architecture with layer-wise prompts.
23
+
24
+ MVP-story is specially designed for story generation tasks, such as ROCStories and WritingPrompts.
25
+
26
+ ## Example
27
+ ```python
28
+ >>> from transformers import MvpTokenizer, MvpForConditionalGeneration
29
+
30
+ >>> tokenizer = MvpTokenizer.from_pretrained("RUCAIBox/mvp")
31
+ >>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp-story")
32
+
33
+ >>> inputs = tokenizer(
34
+ ... "Given the story title: I think all public schools should have a uniform dress code.",
35
+ ... return_tensors="pt",
36
+ ... )
37
+ >>> generated_ids = model.generate(**inputs, max_length=1024)
38
+ >>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
39
+ ['I think it would be a good idea to have uniform dress codes for all public schools. It would make it easier for students to dress appropriately.']
40
+ ```
41
+
42
+ ## Citation