pszemraj commited on
Commit
ad9f4d2
1 Parent(s): 70c4968

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -4
README.md CHANGED
@@ -35,13 +35,32 @@ inference:
35
 
36
  # opt for email generation - 350M
37
 
38
- - This model is a fine-tuned version of [facebook/opt-350m](https://huggingface.co/facebook/opt-350m) on the [aeslc](https://huggingface.co/datasets/aeslc) dataset for six epochs.
39
- - Emails, phone numbers, etc were attempted to be excluded in a dataset preparation step using [clean-text](https://pypi.org/project/clean-text/) in Python.
40
- - Note that API is restricted to generate 64 tokens - you can generate longer emails by using this in a text-generation `pipeline` object
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  ## Model description
43
 
44
- More information needed
 
 
45
 
46
  ## Intended uses & limitations
47
 
 
35
 
36
  # opt for email generation - 350M
37
 
38
+ Why write the rest of your email when you can generate it?
39
+
40
+ ```
41
+ from transformers import pipeline
42
+
43
+ model_tag = "pszemraj/opt-350m-email-generation"
44
+ generator = pipeline(
45
+ 'text-generation',
46
+ model=model_tag,
47
+ do_sample=True,
48
+ )
49
+
50
+ prompt = """
51
+ Hello,
52
+ I just wanted to follow up on the bubblegum shipment."""
53
+ # generate
54
+ generator(prompt)
55
+ ```
56
+
57
+ > For this model, formatting matters. The results may be (significantly) different between the structure outlined above and `prompt = "Hey, just wanted to ..."` etc.
58
 
59
  ## Model description
60
 
61
+ - This model is a fine-tuned version of [facebook/opt-350m](https://huggingface.co/facebook/opt-350m) on the [aeslc](https://huggingface.co/datasets/aeslc) dataset for six epochs.
62
+ - Emails, phone numbers, etc were attempted to be excluded in a dataset preparation step using [clean-text](https://pypi.org/project/clean-text/) in Python.
63
+ - Note that API is restricted to generate 64 tokens - you can generate longer emails by using this in a text-generation `pipeline` object
64
 
65
  ## Intended uses & limitations
66