Update README.md
Browse files
README.md
CHANGED
|
@@ -7,6 +7,17 @@ widget:
|
|
| 7 |
- text: "My dream is"
|
| 8 |
---
|
| 9 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
<div>
|
| 11 |
<div style="width: 132px; height:132px; border-radius: 50%; background-size: cover; background-image: url('http://pbs.twimg.com/profile_images/573383872/img_0621_400x400.jpg')">
|
| 12 |
</div>
|
|
@@ -30,35 +41,56 @@ To understand how the model was developed, check the [W&B report](https://bit.ly
|
|
| 30 |
|
| 31 |
The model was trained on [@l2k's tweets](https://twitter.com/l2k).
|
| 32 |
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 41 |
|
| 42 |
## Training procedure
|
| 43 |
|
| 44 |
The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on @l2k's tweets.
|
| 45 |
|
| 46 |
-
Hyperparameters and metrics are recorded in the [W&B training run](https://app.wandb.ai/wandb/huggingtweets-dev/runs/
|
|
|
|
|
|
|
| 47 |
|
| 48 |
## Intended uses & limitations
|
| 49 |
|
| 50 |
-
|
| 51 |
|
| 52 |
You can use this model directly with a pipeline for text generation:
|
| 53 |
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
```
|
| 60 |
|
| 61 |
-
|
| 62 |
|
| 63 |
The model suffers from [the same limitations and bias as GPT-2](https://huggingface.co/gpt2#limitations-and-bias).
|
| 64 |
|
|
@@ -68,8 +100,12 @@ In addition, the data present in the user's tweets further affects the text gene
|
|
| 68 |
|
| 69 |
*Built by Boris Dayma*
|
| 70 |
|
|
|
|
|
|
|
| 71 |
[](https://twitter.com/borisdayma)
|
| 72 |
|
|
|
|
| 73 |
For more details, visit the project repository.
|
|
|
|
| 74 |
|
| 75 |
[](https://github.com/borisdayma/huggingtweets)
|
|
|
|
| 7 |
- text: "My dream is"
|
| 8 |
---
|
| 9 |
|
| 10 |
+
<link rel="stylesheet" href="https://unpkg.com/@tailwindcss/typography@0.2.x/dist/typography.min.css">
|
| 11 |
+
|
| 12 |
+
<style>
|
| 13 |
+
@media (prefers-color-scheme: dark) {
|
| 14 |
+
.prose { color: #E2E8F0 !important; }
|
| 15 |
+
.prose h2, .prose h3, .prose a, .prose thead { color: #F7FAFC !important; }
|
| 16 |
+
}
|
| 17 |
+
</style>
|
| 18 |
+
|
| 19 |
+
<section class='prose'>
|
| 20 |
+
|
| 21 |
<div>
|
| 22 |
<div style="width: 132px; height:132px; border-radius: 50%; background-size: cover; background-image: url('http://pbs.twimg.com/profile_images/573383872/img_0621_400x400.jpg')">
|
| 23 |
</div>
|
|
|
|
| 41 |
|
| 42 |
The model was trained on [@l2k's tweets](https://twitter.com/l2k).
|
| 43 |
|
| 44 |
+
<table style='border-width:0'>
|
| 45 |
+
<thead style='border-width:0'>
|
| 46 |
+
<tr style='border-width:0 0 1px 0; border-color: #CBD5E0'>
|
| 47 |
+
<th style='border-width:0'>Data</th>
|
| 48 |
+
<th style='border-width:0'>Quantity</th>
|
| 49 |
+
</tr>
|
| 50 |
+
</thead>
|
| 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'>2569</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'>594</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'>87</td>
|
| 63 |
+
</tr>
|
| 64 |
+
<tr style='border-width:0'>
|
| 65 |
+
<td style='border-width:0'>Tweets kept</td>
|
| 66 |
+
<td style='border-width:0'>1888</td>
|
| 67 |
+
</tr>
|
| 68 |
+
</tbody>
|
| 69 |
+
</table>
|
| 70 |
+
|
| 71 |
+
[Explore the data](https://app.wandb.ai/wandb/huggingtweets-dev/runs/27nq9kzg/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 @l2k's tweets.
|
| 76 |
|
| 77 |
+
Hyperparameters and metrics are recorded in the [W&B training run](https://app.wandb.ai/wandb/huggingtweets-dev/runs/6edmz7mo) for full transparency and reproducibility.
|
| 78 |
+
|
| 79 |
+
At the end of training, [the final model](https://app.wandb.ai/wandb/huggingtweets-dev/runs/6edmz7mo/artifacts) is logged and versioned.
|
| 80 |
|
| 81 |
## Intended uses & limitations
|
| 82 |
|
| 83 |
+
### How to use
|
| 84 |
|
| 85 |
You can use this model directly with a pipeline for text generation:
|
| 86 |
|
| 87 |
+
<pre><code><span style="color:#03A9F4">from</span> transformers <span style="color:#03A9F4">import</span> pipeline
|
| 88 |
+
generator = pipeline(<span style="color:#FF9800">'text-generation'</span>,
|
| 89 |
+
model=<span style="color:#FF9800">'huggingtweets/l2k'</span>)
|
| 90 |
+
generator(<span style="color:#FF9800">"My dream is"</span>, num_return_sequences=<span style="color:#8BC34A">5</span>)</code></pre>
|
| 91 |
+
|
|
|
|
| 92 |
|
| 93 |
+
### Limitations and bias
|
| 94 |
|
| 95 |
The model suffers from [the same limitations and bias as GPT-2](https://huggingface.co/gpt2#limitations-and-bias).
|
| 96 |
|
|
|
|
| 100 |
|
| 101 |
*Built by Boris Dayma*
|
| 102 |
|
| 103 |
+
</section>
|
| 104 |
+
|
| 105 |
[](https://twitter.com/borisdayma)
|
| 106 |
|
| 107 |
+
<section class='prose'>
|
| 108 |
For more details, visit the project repository.
|
| 109 |
+
</section>
|
| 110 |
|
| 111 |
[](https://github.com/borisdayma/huggingtweets)
|