julien-c HF staff commited on
Commit
6f3386b
1 Parent(s): 2e2de1a

Migrate model card from transformers-repo

Browse files

Read announcement at https://discuss.huggingface.co/t/announcement-all-model-cards-will-be-migrated-to-hf-co-model-repos/2755
Original file history: https://github.com/huggingface/transformers/commits/master/model_cards/LorenzoDeMattei/GePpeTto/README.md

Files changed (1) hide show
  1. README.md +141 -0
README.md ADDED
@@ -0,0 +1,141 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: it
3
+ ---
4
+
5
+ # GePpeTto GPT2 Model 🇮🇹
6
+
7
+ Pretrained GPT2 117M model for Italian.
8
+
9
+ You can find further details in the paper:
10
+
11
+ Lorenzo De Mattei, Michele Cafagna, Felice Dell’Orletta, Malvina Nissim, Marco Guerini "GePpeTto Carves Italian into a Language Model", arXiv preprint. Pdf available at: https://arxiv.org/abs/2004.14253
12
+
13
+ ## Pretraining Corpus
14
+
15
+ The pretraining set comprises two main sources. The first one is a dump of Italian Wikipedia (November 2019),
16
+ consisting of 2.8GB of text. The second one is the ItWac corpus (Baroni et al., 2009), which amounts to 11GB of web
17
+ texts. This collection provides a mix of standard and less standard Italian, on a rather wide chronological span,
18
+ with older texts than the Wikipedia dump (the latter stretches only to the late 2000s).
19
+
20
+ ## Pretraining details
21
+
22
+ This model was trained using GPT2's Hugging Face implemenation on 4 NVIDIA Tesla T4 GPU for 620k steps.
23
+
24
+ Training parameters:
25
+
26
+ - GPT-2 small configuration
27
+ - vocabulary size: 30k
28
+ - Batch size: 32
29
+ - Block size: 100
30
+ - Adam Optimizer
31
+ - Initial learning rate: 5e-5
32
+ - Warm up steps: 10k
33
+
34
+ ## Perplexity scores
35
+
36
+ | Domain | Perplexity |
37
+ |---|---|
38
+ | Wikipedia | 26.1052 |
39
+ | ItWac | 30.3965 |
40
+ | Legal | 37.2197 |
41
+ | News | 45.3859 |
42
+ | Social Media | 84.6408 |
43
+
44
+ For further details, qualitative analysis and human evaluation check out: https://arxiv.org/abs/2004.14253
45
+
46
+ ## Load Pretrained Model
47
+
48
+ You can use this model by installing Huggingface library `transformers`. And you can use it directly by initializing it like this:
49
+
50
+ ```python
51
+ from transformers import GPT2Tokenizer, GPT2Model
52
+
53
+ model = GPT2Model.from_pretrained('LorenzoDeMattei/GePpeTto')
54
+ tokenizer = GPT2Tokenizer.from_pretrained(
55
+ 'LorenzoDeMattei/GePpeTto',
56
+ )
57
+ ```
58
+
59
+ ## Example using GPT2LMHeadModel
60
+
61
+ ```python
62
+ from transformers import AutoTokenizer, AutoModelWithLMHead, pipeline, GPT2Tokenizer
63
+
64
+ tokenizer = AutoTokenizer.from_pretrained("LorenzoDeMattei/GePpeTto")
65
+ model = AutoModelWithLMHead.from_pretrained("LorenzoDeMattei/GePpeTto")
66
+
67
+ text_generator = pipeline('text-generation', model=model, tokenizer=tokenizer)
68
+ prompts = [
69
+ "Wikipedia Geppetto",
70
+ "Maestro Ciliegia regala il pezzo di legno al suo amico Geppetto, il quale lo prende per fabbricarsi un burattino maraviglioso"]
71
+
72
+
73
+ samples_outputs = text_generator(
74
+ prompts,
75
+ do_sample=True,
76
+ max_length=50,
77
+ top_k=50,
78
+ top_p=0.95,
79
+ num_return_sequences=3
80
+ )
81
+
82
+
83
+ for i, sample_outputs in enumerate(samples_outputs):
84
+ print(100 * '-')
85
+ print("Prompt:", prompts[i])
86
+ for sample_output in sample_outputs:
87
+ print("Sample:", sample_output['generated_text'])
88
+ print()
89
+
90
+ ```
91
+
92
+ Output is,
93
+
94
+ ```
95
+ ----------------------------------------------------------------------------------------------------
96
+ Prompt: Wikipedia Geppetto
97
+ Sample: Wikipedia Geppetto rosso (film 1920)
98
+
99
+ Geppetto rosso ("The Smokes in the Black") è un film muto del 1920 diretto da Henry H. Leonard.
100
+
101
+ Il film fu prodotto dalla Selig Poly
102
+
103
+ Sample: Wikipedia Geppetto
104
+
105
+ Geppetto ("Geppetto" in piemontese) è un comune italiano di 978 abitanti della provincia di Cuneo in Piemonte.
106
+
107
+ L'abitato, che si trova nel versante valtellinese, si sviluppa nella
108
+
109
+ Sample: Wikipedia Geppetto di Natale (romanzo)
110
+
111
+ Geppetto di Natale è un romanzo di Mario Caiano, pubblicato nel 2012.
112
+
113
+ ----------------------------------------------------------------------------------------------------
114
+ Prompt: Maestro Ciliegia regala il pezzo di legno al suo amico Geppetto, il quale lo prende per fabbricarsi un burattino maraviglioso
115
+ Sample: Maestro Ciliegia regala il pezzo di legno al suo amico Geppetto, il quale lo prende per fabbricarsi un burattino maraviglioso. Il burattino riesce a scappare. Dopo aver trovato un prezioso sacchetto si reca
116
+
117
+ Sample: Maestro Ciliegia regala il pezzo di legno al suo amico Geppetto, il quale lo prende per fabbricarsi un burattino maraviglioso, e l'unico che lo possiede, ma, di fronte a tutte queste prove
118
+
119
+ Sample: Maestro Ciliegia regala il pezzo di legno al suo amico Geppetto, il quale lo prende per fabbricarsi un burattino maraviglioso: - A voi gli occhi, le guance! A voi il mio pezzo!
120
+ ```
121
+
122
+ ## Citation
123
+
124
+ Please use the following bibtex entry:
125
+
126
+ ```
127
+ @misc{mattei2020geppetto,
128
+ title={GePpeTto Carves Italian into a Language Model},
129
+ author={Lorenzo De Mattei and Michele Cafagna and Felice Dell'Orletta and Malvina Nissim and Marco Guerini},
130
+ year={2020},
131
+ eprint={2004.14253},
132
+ archivePrefix={arXiv},
133
+ primaryClass={cs.CL}
134
+ }
135
+ ```
136
+
137
+ ## References
138
+
139
+ Marco Baroni, Silvia Bernardini, Adriano Ferraresi,
140
+ and Eros Zanchetta. 2009. The WaCky wide web: a
141
+ collection of very large linguistically processed webcrawled corpora. Language resources and evaluation, 43(3):209–226.