1-800-BAD-CODE commited on
Commit
ef74cf6
1 Parent(s): 500f385

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -6
README.md CHANGED
@@ -22,7 +22,7 @@ The easy way to use this model is to install [punctuators](https://github.com/1-
22
  pip install punctuators
23
  ```
24
 
25
- Running the following script should load this model and run some random texts I made up or found:
26
 
27
  <details open>
28
 
@@ -37,11 +37,12 @@ m = PunctCapSegModelONNX.from_pretrained("pcs_en")
37
 
38
  # Define some input texts to punctuate
39
  input_texts: List[str] = [
40
- "george hw bush was the president of the us for 8 years",
41
  "i woke up at 6 am and took the dog for a hike in the metacomet mountains we like to take morning adventures on the weekends",
42
  "despite being mid march it snowed overnight and into the morning here in connecticut it was snowier up in the mountains than in the farmington valley where i live",
 
 
43
  "i saw mr smith at the store he was shopping for a new lawn mower i suggested he get one of those new battery operated ones they're so much quieter",
44
- # See how the model performs on made-up acronyms
45
  "i went to the fgw store and bought a new tg optical scope",
46
  # First few sentences from today's featured article on wikipedia
47
  "it's that man again itma was a radio comedy programme that was broadcast by the bbc for twelve series from 1939 to 1949 featuring tommy handley in the central role itma was a character driven comedy whose satirical targets included officialdom and the proliferation of minor wartime regulations parts of the scripts were rewritten in the hours before the broadcast to ensure topicality"
@@ -65,9 +66,6 @@ Exact output may vary based on the model version; here is the current output:
65
  <summary>Expected Output</summary>
66
 
67
  ```text
68
- In: george hw bush was the president of the us for 8 years
69
- Out: George H.W. Bush was the president of the U.S. for 8 years.
70
-
71
  In: i woke up at 6 am and took the dog for a hike in the metacomet mountains we like to take morning adventures on the weekends
72
  Out: I woke up at 6 a.m. and took the dog for a hike in the Metacomet Mountains.
73
  Out: We like to take morning adventures on the weekends.
@@ -76,6 +74,13 @@ In: despite being mid march it snowed overnight and into the morning here in con
76
  Out: Despite being mid March, it snowed overnight and into the morning.
77
  Out: Here in Connecticut, it was snowier up in the mountains than in the Farmington Valley where I live.
78
 
 
 
 
 
 
 
 
79
  In: i saw mr smith at the store he was shopping for a new lawn mower i suggested he get one of those new battery operated ones they're so much quieter
80
  Out: I saw Mr. Smith at the store he was shopping for a new lawn mower.
81
  Out: I suggested he get one of those new battery operated ones.
 
22
  pip install punctuators
23
  ```
24
 
25
+ Let's punctuate my weekend recap, as well as few interesting sentences with acronyms and abbreviations that I made up or found on Wikipedia:
26
 
27
  <details open>
28
 
 
37
 
38
  # Define some input texts to punctuate
39
  input_texts: List[str] = [
 
40
  "i woke up at 6 am and took the dog for a hike in the metacomet mountains we like to take morning adventures on the weekends",
41
  "despite being mid march it snowed overnight and into the morning here in connecticut it was snowier up in the mountains than in the farmington valley where i live",
42
+ "when i got home i trained this model on the lambda cloud on an a100 gpu with about 10 million lines of text the total budget was less than 5 dollars",
43
+ "george hw bush was the president of the us for 8 years",
44
  "i saw mr smith at the store he was shopping for a new lawn mower i suggested he get one of those new battery operated ones they're so much quieter",
45
+ # See how the model performs on made-up acronyms
46
  "i went to the fgw store and bought a new tg optical scope",
47
  # First few sentences from today's featured article on wikipedia
48
  "it's that man again itma was a radio comedy programme that was broadcast by the bbc for twelve series from 1939 to 1949 featuring tommy handley in the central role itma was a character driven comedy whose satirical targets included officialdom and the proliferation of minor wartime regulations parts of the scripts were rewritten in the hours before the broadcast to ensure topicality"
 
66
  <summary>Expected Output</summary>
67
 
68
  ```text
 
 
 
69
  In: i woke up at 6 am and took the dog for a hike in the metacomet mountains we like to take morning adventures on the weekends
70
  Out: I woke up at 6 a.m. and took the dog for a hike in the Metacomet Mountains.
71
  Out: We like to take morning adventures on the weekends.
 
74
  Out: Despite being mid March, it snowed overnight and into the morning.
75
  Out: Here in Connecticut, it was snowier up in the mountains than in the Farmington Valley where I live.
76
 
77
+ In: when i got home i trained this model on the lambda cloud on an a100 gpu with about 10 million lines of text the total budget was less than 5 dollars
78
+ Out: When I got home, I trained this model on the Lambda Cloud.
79
+ Out: On an A100 GPU with about 10 million lines of text, the total budget was less than 5 dollars.
80
+
81
+ In: george hw bush was the president of the us for 8 years
82
+ Out: George H.W. Bush was the president of the U.S. for 8 years.
83
+
84
  In: i saw mr smith at the store he was shopping for a new lawn mower i suggested he get one of those new battery operated ones they're so much quieter
85
  Out: I saw Mr. Smith at the store he was shopping for a new lawn mower.
86
  Out: I suggested he get one of those new battery operated ones.