docs: Added training using augmenty example

[KennethEnevoldsen]

Fixes #33

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty
__init__.py	22	0	100%
augment_utilities.py	36	1	97%	57
keyboard.py	41	1	98%	40
util.py	41	1	98%	71
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/character
__init__.py	5	0	100%
casing.py	20	0	100%
replace.py	34	0	100%
spacing.py	20	0	100%
swap.py	21	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/doc
__init__.py	3	0	100%
casing.py	27	0	100%
subset.py	44	5	89%	30, 49, 53, 55, 61
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang
__init__.py	17	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/da
__init__.py	3	0	100%
augmenters.py	17	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/de
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/el
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/en
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/es
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/fr
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/hu
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/it
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/lt
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/mk
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/nb
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/nl
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/pl
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/pt
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/ro
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/lang/ru
__init__.py	1	0	100%
keyboard.py	5	0	100%
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/span
__init__.py	3	0	100%
entities.py	150	10	93%	35, 53–61, 364
utils.py	15	3	80%	20, 31, 37
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/augmenty/token
__init__.py	9	0	100%
casing.py	42	1	98%	111
insert.py	103	6	94%	36, 53–54, 198, 265, 283
replace.py	103	6	94%	36, 201, 205, 241, 287, 301
spacing.py	39	0	100%
static_embedding_util.py	35	1	97%	67
swap.py	62	4	94%	50, 80, 91, 104
wordnet_util.py	10	3	70%	7–9
TOTAL	1017	42	96%