Update README.md

README.md

@@ -2,23 +2,76 @@
 license: apache-2.0
 tags:
 - generated_from_trainer
-model-index:
-- name: distilgpt2-emailgen_DS-multi_Ep-5_Bs-8
-  results: []
+- email generation
+- email
+datasets:
+- aeslc
+- postbot/multi_emails
+
+widget:
+- text: "Hey <NAME>,\n\nThank you for signing up for my weekly newsletter. Before we get started, you'll have to confirm your email address." 
+  example_title: "newsletter"
+- text: "Hi <NAME>,\n\nI hope this email finds you well. Let me start by saying that I am a big fan of your work." 
+  example_title: "fan"
+- text: "Greetings <NAME>,\n\nI hope you had a splendid evening at the Company sausage eating festival. I am reaching out because" 
+  example_title: "festival"
+- text: "Good Morning <NAME>,\n\nI was just thinking to myself about how much I love creating value" 
+  example_title: "value"
+- text: "URGENT - I need the TPS reports"
+  example_title: "URGENT"
+- text: "Hi <NAME>,\n\nI hope this email finds you extremely well." 
+  example_title: "emails that find you"
+
+parameters:
+  min_length: 4
+  max_length: 96
+  length_penalty: 0.7
+  no_repeat_ngram_size: 2
+  do_sample: False
+  num_beams: 4
+  early_stopping: True
+  repetition_penalty: 2.5
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
 
-# distilgpt2-emailgen_DS-multi_Ep-5_Bs-8
+# distilgpt2-emailgen
 
-This model is a fine-tuned version of [distilgpt2](https://huggingface.co/distilgpt2) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 2.6247
+Why write the rest of your email when you can generate it?
+
+```python
+from transformers import pipeline
+
+model_tag = "pszemraj/gpt2-medium-email-generation"
+generator = pipeline(
+              'text-generation', 
+              model=model_tag, 
+              use_fast=False,
+              do_sample=False,
+              early_stopping=True,
+            )
+            
+prompt = """
+Hello, 
+
+Following up on the bubblegum shipment."""
+
+generator(
+    prompt,
+    max_length=64,
+) # generate
+```
+
+A script to use this on CPU/command line can be found [here](https://gist.github.com/pszemraj/c1b0a76445418b6bbddd5f9633d1bb7f) :) 
+
+> For this model, formatting matters. The results may be (significantly) different between the structure outlined above and `prompt = "Hey, just wanted to ..."` etc.
 
 ## Model description
 
-More information needed
+This model is a fine-tuned version of [distilgpt2](https://huggingface.co/distilgpt2) on a dataset of 50k emails, including the classic `aeslc` dataset.
+
+It achieves the following results on the evaluation set:
+- Loss: 2.6247
+
 
 ## Intended uses & limitations