Docs update for #18

[agerada]

Closes #18

[github-actions[bot]]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/aigarmic
_img_utils.py	68	26	61%	43–45, 93–111, 123, 132–135
_nn_design.py	15	5	58%	42–>44, 51–75
clean_up_annotations.py	30	30	0%	10–55
file_handlers.py	63	7	86%	98–104, 110–>117, 166
main.py	96	35	59%	68–96, 99, 102, 109, 117–118, 122–128, 135, 153–155, 158–>exit, 168–>exit
manual_annotator.py	70	70	0%	14–108
model.py	78	17	74%	26, 37, 59–61, 75, 91–98, 118, 120, 179
model_performance.py	56	56	0%	11–92
plate.py	404	100	75%	54–55, 61–62, 77, 79–>82, 89, 102, 149, 161, 186, 196–198, 210, 222–224, 235, 242, 262, 268–272, 291–298, 310, 339–391, 418, 421, 424, 427, 430, 433, 453, 459–460, 462, 464, 468, 470, 477, 479, 523, 525–>536, 584, 588, 618, 654, 656, 671
process_plate_image.py	48	6	88%	69, 75–78, 81
rename_images.py	26	26	0%	10–59
train.py	88	19	80%	65, 181–202
train_modular.py	60	60	0%	10–120
TOTAL	1108	457	58%

Tests	Skipped	Failures	Errors	Time
27	0 :zzz:	0 :x:	0 :fire:	7m 56s :stopwatch: