oliverguhr commited on
Commit
0e08f2c
1 Parent(s): 665fec6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -1
README.md CHANGED
@@ -13,4 +13,23 @@ metrics:
13
  - cer
14
  ---
15
 
16
- This is an experimental model that should fix your typos and punctuation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  - cer
14
  ---
15
 
16
+ This is an experimental model that should fix your typos and punctuation.
17
+
18
+
19
+
20
+ ## Model description
21
+
22
+ This is a proof of concept spelling correction model for english.
23
+
24
+ ## Intended uses & limitations
25
+
26
+ This is work in progress, be aware that the model can produce artefacts.
27
+ You can test the model using the pipeline interface:
28
+
29
+ ```python
30
+ from transformers import pipeline
31
+
32
+ fix_spelling = pipeline("text2text-generation",model="oliverguhr/spelling-correction-english-base")
33
+
34
+ print(fix_spelling("lets do a comparsion",max_length=2048))
35
+ ```