Skip to content

Commit 7138f2b

Browse files
committed
Update docs
1 parent 95163e5 commit 7138f2b

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/architecture.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,14 @@ prediction for a single plate will be of shape `(max_plate_slots, vocabulary_siz
1919

2020
During training, you will see the following metrics
2121

22-
* **plate_acc**: Compute how many plates were correctly classified. For a single plate, if ground truth is `ABC123`, and
23-
the prediction is 'ABC 123', then this would give a score of 1. If the prediction was ABD 123, it would
24-
score 0.
25-
* **cat_acc**: Calculates how many characters of the plate were correctly classified. Example if the correct label is
26-
`ABC123` and `ABC133` is predicted, it will not give a precision of 0% like plate_acc (not completely
27-
classified correctly), but 83.3% (5/6).
28-
* **top_3_k**: Calculates how often the true character is found in the top-3 predictions (the 3 with the highest
29-
probability).
22+
* **plate_acc**: Compute the number of **license plates** that were **fully classified**. For a single plate, if the
23+
ground truth is `ABC123` and the prediction is also `ABC123`, it would score 1. However, if the prediction was
24+
`ABD123`, it would score 0, as **not all characters** were correctly classified.
25+
26+
* **cat_acc**: Calculate the accuracy of **individual characters** within the license plates that were
27+
**correctly classified**. For example, if the correct label is `ABC123` and the prediction is `ABC133`, it would yield
28+
a precision of 83.3% (5 out of 6 characters correctly classified), rather than 0% as in plate_acc, because it's not
29+
completely classified correctly.
30+
31+
* **top_3_k**: Calculate how frequently the true character is included in the **top-3 predictions**
32+
(the three predictions with the highest probability).

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ To train the model you will need:
8787
--reduce-lr-patience 50
8888
```
8989

90-
You will probably want to change the augmentation pipeline to apply to your dataset. In order to do this
90+
You will probably want to change the augmentation pipeline to apply to your dataset.
9191

92-
Define Albumentations pipeline:
92+
In order to do this define an Albumentations pipeline:
9393

9494
```python
9595
import albumentations as A

0 commit comments

Comments
 (0)