boris commited on
Commit
ac07abf
1 Parent(s): eaa0830

New model from https://wandb.ai/wandb/huggingtweets/runs/2yl0izon

Browse files
Files changed (1) hide show
  1. README.md +85 -0
README.md ADDED
@@ -0,0 +1,85 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: en
3
+ thumbnail: https://github.com/borisdayma/huggingtweets/blob/master/img/logo.png?raw=true
4
+ tags:
5
+ - huggingtweets
6
+ widget:
7
+ - text: "My dream is"
8
+ ---
9
+
10
+ <div class="inline-flex flex-col" style="line-height: 1.5;">
11
+ <div class="flex">
12
+ <div
13
+ style="display:inherit; margin-left: 4px; margin-right: 4px; width: 92px; height:92px; border-radius: 50%; background-size: cover; background-image: url(&#39;https://pbs.twimg.com/profile_images/1311655714767601665/8z7UZ1u5_400x400.jpg&#39;)">
14
+ </div>
15
+ <div
16
+ style="display:inherit; margin-left: 4px; margin-right: 4px; width: 92px; height:92px; border-radius: 50%; background-size: cover; background-image: url(&#39;https://pbs.twimg.com/profile_images/1145832571214815232/KYNcOP04_400x400.jpg&#39;)">
17
+ </div>
18
+ <div
19
+ style="display:inherit; margin-left: 4px; margin-right: 4px; width: 92px; height:92px; border-radius: 50%; background-size: cover; background-image: url(&#39;https://pbs.twimg.com/profile_images/1396296635672502273/ZLagDVRa_400x400.jpg&#39;)">
20
+ </div>
21
+ </div>
22
+ <div style="text-align: center; margin-top: 3px; font-size: 16px; font-weight: 800">🤖 AI CYBORG 🤖</div>
23
+ <div style="text-align: center; font-size: 16px; font-weight: 800">千坂恭二 :『哲学問答2020・ウィルス塹壕戦』 & Go Ando / PREDUCTS / THE GUILD & takano@MAMORI0</div>
24
+ <div style="text-align: center; font-size: 14px;">@chisaka_kyoji-goando-iototaku</div>
25
+ </div>
26
+
27
+ I was made with [huggingtweets](https://github.com/borisdayma/huggingtweets).
28
+
29
+ Create your own bot based on your favorite user with [the demo](https://colab.research.google.com/github/borisdayma/huggingtweets/blob/master/huggingtweets-demo.ipynb)!
30
+
31
+ ## How does it work?
32
+
33
+ The model uses the following pipeline.
34
+
35
+ ![pipeline](https://github.com/borisdayma/huggingtweets/blob/master/img/pipeline.png?raw=true)
36
+
37
+ To understand how the model was developed, check the [W&B report](https://wandb.ai/wandb/huggingtweets/reports/HuggingTweets-Train-a-Model-to-Generate-Tweets--VmlldzoxMTY5MjI).
38
+
39
+ ## Training data
40
+
41
+ The model was trained on tweets from 千坂恭二 :『哲学問答2020・ウィルス塹壕戦』 & Go Ando / PREDUCTS / THE GUILD & takano@MAMORI0.
42
+
43
+ | Data | 千坂恭二 :『哲学問答2020・ウィルス塹壕戦』 | Go Ando / PREDUCTS / THE GUILD | takano@MAMORI0 |
44
+ | --- | --- | --- | --- |
45
+ | Tweets downloaded | 3246 | 3246 | 3233 |
46
+ | Retweets | 957 | 90 | 1144 |
47
+ | Short tweets | 455 | 1680 | 634 |
48
+ | Tweets kept | 1834 | 1476 | 1455 |
49
+
50
+ [Explore the data](https://wandb.ai/wandb/huggingtweets/runs/i7bv0620/artifacts), which is tracked with [W&B artifacts](https://docs.wandb.com/artifacts) at every step of the pipeline.
51
+
52
+ ## Training procedure
53
+
54
+ The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on @chisaka_kyoji-goando-iototaku's tweets.
55
+
56
+ Hyperparameters and metrics are recorded in the [W&B training run](https://wandb.ai/wandb/huggingtweets/runs/2yl0izon) for full transparency and reproducibility.
57
+
58
+ At the end of training, [the final model](https://wandb.ai/wandb/huggingtweets/runs/2yl0izon/artifacts) is logged and versioned.
59
+
60
+ ## How to use
61
+
62
+ You can use this model directly with a pipeline for text generation:
63
+
64
+ ```python
65
+ from transformers import pipeline
66
+ generator = pipeline('text-generation',
67
+ model='huggingtweets/chisaka_kyoji-goando-iototaku')
68
+ generator("My dream is", num_return_sequences=5)
69
+ ```
70
+
71
+ ## Limitations and bias
72
+
73
+ The model suffers from [the same limitations and bias as GPT-2](https://huggingface.co/gpt2#limitations-and-bias).
74
+
75
+ In addition, the data present in the user's tweets further affects the text generated by the model.
76
+
77
+ ## About
78
+
79
+ *Built by Boris Dayma*
80
+
81
+ [![Follow](https://img.shields.io/twitter/follow/borisdayma?style=social)](https://twitter.com/intent/follow?screen_name=borisdayma)
82
+
83
+ For more details, visit the project repository.
84
+
85
+ [![GitHub stars](https://img.shields.io/github/stars/borisdayma/huggingtweets?style=social)](https://github.com/borisdayma/huggingtweets)