Update README.md
Browse files
README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1 |
---
|
2 |
language: en
|
3 |
-
thumbnail: https://github.com/borisdayma/huggingtweets/blob/master/img/
|
4 |
tags:
|
5 |
- huggingtweets
|
6 |
widget:
|
@@ -35,7 +35,7 @@ The model uses the following pipeline.
|
|
35 |
|
36 |
![pipeline](https://github.com/borisdayma/huggingtweets/blob/master/img/pipeline.png?raw=true)
|
37 |
|
38 |
-
To understand how the model was developed, check the [W&B report](https://
|
39 |
|
40 |
## Training data
|
41 |
|
@@ -51,32 +51,32 @@ The model was trained on [@julien_c's tweets](https://twitter.com/julien_c).
|
|
51 |
<tbody style='border-width:0'>
|
52 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
53 |
<td style='border-width:0'>Tweets downloaded</td>
|
54 |
-
<td style='border-width:0'>
|
55 |
</tr>
|
56 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
57 |
<td style='border-width:0'>Retweets</td>
|
58 |
-
<td style='border-width:0'>
|
59 |
</tr>
|
60 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
61 |
<td style='border-width:0'>Short tweets</td>
|
62 |
-
<td style='border-width:0'>
|
63 |
</tr>
|
64 |
<tr style='border-width:0'>
|
65 |
<td style='border-width:0'>Tweets kept</td>
|
66 |
-
<td style='border-width:0'>
|
67 |
</tr>
|
68 |
</tbody>
|
69 |
</table>
|
70 |
|
71 |
-
[Explore the data](https://app.wandb.ai/wandb/huggingtweets/runs/
|
72 |
|
73 |
## Training procedure
|
74 |
|
75 |
The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on @julien_c's tweets.
|
76 |
|
77 |
-
Hyperparameters and metrics are recorded in the [W&B training run](https://app.wandb.ai/wandb/huggingtweets/runs/
|
78 |
|
79 |
-
At the end of training, [the final model](https://app.wandb.ai/wandb/huggingtweets/runs/
|
80 |
|
81 |
## Intended uses & limitations
|
82 |
|
@@ -102,7 +102,7 @@ In addition, the data present in the user's tweets further affects the text gene
|
|
102 |
|
103 |
</section>
|
104 |
|
105 |
-
[![Follow](https://img.shields.io/twitter/follow/borisdayma?style=social)](https://twitter.com/borisdayma)
|
106 |
|
107 |
<section class='prose'>
|
108 |
For more details, visit the project repository.
|
|
|
1 |
---
|
2 |
language: en
|
3 |
+
thumbnail: https://github.com/borisdayma/huggingtweets/blob/master/img/logo.png?raw=true
|
4 |
tags:
|
5 |
- huggingtweets
|
6 |
widget:
|
|
|
35 |
|
36 |
![pipeline](https://github.com/borisdayma/huggingtweets/blob/master/img/pipeline.png?raw=true)
|
37 |
|
38 |
+
To understand how the model was developed, check the [W&B report](https://app.wandb.ai/wandb/huggingtweets/reports/HuggingTweets-Train-a-model-to-generate-tweets--VmlldzoxMTY5MjI).
|
39 |
|
40 |
## Training data
|
41 |
|
|
|
51 |
<tbody style='border-width:0'>
|
52 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
53 |
<td style='border-width:0'>Tweets downloaded</td>
|
54 |
+
<td style='border-width:0'>3210</td>
|
55 |
</tr>
|
56 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
57 |
<td style='border-width:0'>Retweets</td>
|
58 |
+
<td style='border-width:0'>896</td>
|
59 |
</tr>
|
60 |
<tr style='border-width:0 0 1px 0; border-color: #E2E8F0'>
|
61 |
<td style='border-width:0'>Short tweets</td>
|
62 |
+
<td style='border-width:0'>378</td>
|
63 |
</tr>
|
64 |
<tr style='border-width:0'>
|
65 |
<td style='border-width:0'>Tweets kept</td>
|
66 |
+
<td style='border-width:0'>1936</td>
|
67 |
</tr>
|
68 |
</tbody>
|
69 |
</table>
|
70 |
|
71 |
+
[Explore the data](https://app.wandb.ai/wandb/huggingtweets/runs/2hkg5frb/artifacts), which is tracked with [W&B artifacts](https://docs.wandb.com/artifacts) at every step of the pipeline.
|
72 |
|
73 |
## Training procedure
|
74 |
|
75 |
The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on @julien_c's tweets.
|
76 |
|
77 |
+
Hyperparameters and metrics are recorded in the [W&B training run](https://app.wandb.ai/wandb/huggingtweets/runs/315lv2hm) for full transparency and reproducibility.
|
78 |
|
79 |
+
At the end of training, [the final model](https://app.wandb.ai/wandb/huggingtweets/runs/315lv2hm/artifacts) is logged and versioned.
|
80 |
|
81 |
## Intended uses & limitations
|
82 |
|
|
|
102 |
|
103 |
</section>
|
104 |
|
105 |
+
[![Follow](https://img.shields.io/twitter/follow/borisdayma?style=social)](https://twitter.com/intent/follow?screen_name=borisdayma)
|
106 |
|
107 |
<section class='prose'>
|
108 |
For more details, visit the project repository.
|