vennsa commited on
Commit
7721149
·
verified ·
1 Parent(s): 79bc412

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -80
README.md CHANGED
@@ -24,118 +24,102 @@ size_categories:
24
 
25
  # SLR-NoteSense
26
 
27
- SLR-NoteSense is a dual-sensor RGBC dataset for Sri Lankan banknote denomination recognition.
28
 
29
- The dataset contains 12,668 paired sensor measurements collected from 634 distinct physical Sri Lankan banknotes across six denominations:
30
-
31
- - LKR 20
32
- - LKR 50
33
- - LKR 100
34
- - LKR 500
35
- - LKR 1000
36
- - LKR 5000
37
 
38
  ## Dataset Details
39
 
40
- Two TCS34725 color sensors were used to collect red, green, blue, and clear-channel measurements.
41
-
42
- Sensor settings:
43
 
44
- - Integration time: 50 ms
45
- - Gain: 4X
46
- - Number of sensors: 2
47
- - Number of physical banknotes: 634
48
- - Raw measurements: 12,668
49
- - Stable measurements after preprocessing: 12,035
 
 
 
 
50
 
51
  ## Dataset Structure
52
 
53
- Each row contains:
54
-
55
- - label
56
- - note_id
57
- - scan_id
58
- - sample_index
59
- - s1_r
60
- - s1_g
61
- - s1_b
62
- - s1_clear
63
- - s1_nr
64
- - s1_ng
65
- - s1_nb
66
- - s2_r
67
- - s2_g
68
- - s2_b
69
- - s2_clear
70
- - s2_nr
71
- - s2_ng
72
- - s2_nb
73
-
74
- Normalized channels are calculated as:
75
-
76
- R/C, G/C, and B/C.
77
 
78
  ## Physical Banknote Distribution
79
 
80
- | Denomination | Physical Banknotes |
81
- |---|---:|
82
- | LKR 20 | 102 |
83
- | LKR 50 | 102 |
84
- | LKR 100 | 106 |
85
- | LKR 500 | 111 |
86
- | LKR 1000 | 106 |
87
- | LKR 5000 | 107 |
88
- | Total | 634 |
 
89
 
90
- ## Preprocessing
91
 
92
- The first sensor reading of each acquisition sequence showed a sensor-settling transient and was excluded from the stable dataset.
93
 
94
- A total of 60 missing denomination labels were restored from denomination-specific source files.
 
 
 
 
95
 
96
- For machine-learning evaluation, all measurements from the same physical banknote should remain in the same train, validation, or test partition.
97
 
98
- Use denomination + note_id as the physical-banknote group identifier.
99
 
100
- ## Baseline Validation
101
 
102
- An RBF Support Vector Machine using eight scan-level features achieved:
103
 
104
- - Group-aware repeated cross-validation accuracy: 98.33%
105
- - Macro F1-score: 98.33%
106
- - Group-held-out accuracy: 96.85%
107
- - Python-to-C++ prediction agreement: 634/634
108
 
109
- These results are provided as technical validation of the dataset.
110
 
111
- ## Intended Uses
112
 
113
- This dataset is intended for research in:
114
 
115
- - banknote denomination recognition
116
- - embedded machine learning
117
- - color-sensor classification
118
- - assistive technology
119
- - feature engineering
120
- - group-aware machine-learning evaluation
121
 
122
  ## Out-of-Scope Uses
123
 
124
- The dataset is not intended for:
125
-
126
- - counterfeit detection
127
- - banknote authentication
128
- - financial security verification
129
- - banknote valuation
130
 
131
  ## License
132
 
133
- This dataset is released under the Creative Commons Attribution 4.0 International license.
134
 
135
  ## Citation
136
 
137
- Citation information will be added after publication of the associated data paper.
138
 
139
  ## Dataset Version
140
 
141
- Version 1.0
 
24
 
25
  # SLR-NoteSense
26
 
27
+ SLR-NoteSense is a dual-sensor red-green-blue-clear (RGBC) dataset for Sri Lankan banknote denomination recognition. The seven-denomination update adds the LKR 2000 class to the original six-denomination dataset.
28
 
29
+ The dataset contains **14,846 paired acquisition rows** from **743 distinct physical banknotes**, covering LKR **20, 50, 100, 500, 1000, 2000, and 5000**. After applying the documented sensor-settling rule, the stable view contains **14,104 paired measurement rows**.
 
 
 
 
 
 
 
30
 
31
  ## Dataset Details
32
 
33
+ Two TCS34725 color sensors connected to an ESP32-S3 collected red, green, blue, and clear-channel measurements.
 
 
34
 
35
+ | Property | Value |
36
+ |---|---:|
37
+ | Sensors | 2 × TCS34725 |
38
+ | Integration time | 50 ms |
39
+ | Gain | 4× |
40
+ | Denominations | 7 |
41
+ | Distinct physical banknotes | 743 |
42
+ | Raw paired measurements | 14,846 |
43
+ | Stable paired measurements | 14,104 |
44
+ | Derived note-level samples | 743 |
45
 
46
  ## Dataset Structure
47
 
48
+ Each raw measurement row contains the following fields:
49
+
50
+ - `label`: Banknote denomination in LKR; missing in some original source rows.
51
+ - `note_id`: Physical-banknote identifier within its denomination.
52
+ - `scan_id`: Acquisition identifier.
53
+ - `sample_index`: Ordered position within an acquisition sequence.
54
+ - `s1_r`, `s1_g`, `s1_b`, `s1_clear`: Sensor 1 raw RGBC measurements.
55
+ - `s1_nr`, `s1_ng`, `s1_nb`: Sensor 1 R/C, G/C, and B/C ratios.
56
+ - `s2_r`, `s2_g`, `s2_b`, `s2_clear`: Sensor 2 raw RGBC measurements.
57
+ - `s2_nr`, `s2_ng`, `s2_nb`: Sensor 2 R/C, G/C, and B/C ratios.
58
+
59
+ For each sensor, normalized channels are calculated as `R/C`, `G/C`, and `B/C`, where `C` is the clear-channel reading. Each row contains a paired reading from both sensors. Use **(`label`, `note_id`)** as the globally unique physical-banknote key because `note_id` restarts within each denomination.
 
 
 
 
 
 
 
 
 
 
 
 
60
 
61
  ## Physical Banknote Distribution
62
 
63
+ | Denomination (LKR) | Physical banknotes | Raw rows | Stable rows |
64
+ |---|---:|---:|---:|
65
+ | 20 | 102 | 2,038 | 1,936 |
66
+ | 50 | 102 | 2,038 | 1,936 |
67
+ | 100 | 106 | 2,118 | 2,013 |
68
+ | 500 | 111 | 2,218 | 2,107 |
69
+ | 1000 | 106 | 2,118 | 2,012 |
70
+ | 2000 | 109 | 2,178 | 2,069 |
71
+ | 5000 | 107 | 2,138 | 2,031 |
72
+ | **Total** | **743** | **14,846** | **14,104** |
73
 
74
+ The new `2000.csv` contributes 109 distinct LKR 2000 notes. An older eight-note LKR 2000 file is **not included** because its note identifiers overlap with those in the newer file and the physical-note identities are unverified. Do not merge the two files without resolving this overlap.
75
 
76
+ ## Preprocessing and Quality Control
77
 
78
+ 1. Retain the seven original denomination-specific CSV files unchanged.
79
+ 2. Restore **380 missing `label` values** from known source-file provenance: 60 from the original six-denomination files and 320 from the new LKR 2000 file (16 complete scans). Do not infer these labels from sensor readings. The cleaned data includes an `original_label_missing` provenance flag.
80
+ 3. Remove rows with `sample_index == 0` from the derived stable view to exclude the observed sensor-settling transient. Apply this rule only where index 0 exists. **742 of 743** physical-note acquisitions contain index 0; one LKR 100 acquisition starts at index 2.
81
+ 4. Preserve the original sequence lengths. Seven physical-note acquisitions have 18 rather than 20 raw readings.
82
+ 5. For note-level classification, compute eight mean features from stable readings: the R/C, G/C, and B/C ratios for each sensor and the clear-channel mean for each sensor. The reference pipeline recomputes ratios from raw RGBC channels.
83
 
84
+ All clear-channel readings are positive. The source release and derived views should remain distinguishable so preprocessing is reproducible.
85
 
86
+ ## Baseline Technical Validation
87
 
88
+ The seven-class reference baseline uses a `StandardScaler` followed by an RBF support vector machine (`C=5`, `gamma=0.06`) with eight note-level features.
89
 
90
+ Evaluation uses a stratified **physical-banknote-level** split with 594 training notes and a separate 149-note holdout. Five repeats of stratified fivefold cross-validation run only on the training partition. No physical note appears in both partitions.
91
 
92
+ | Evaluation | Accuracy | Macro F1 |
93
+ |---|---:|---:|
94
+ | Training-only repeated fivefold CV (5 × 5) | 98.15% | 98.14% |
95
+ | Separate 149-note holdout | 96.64% | 96.60% |
96
 
97
+ Python-to-C++ prediction parity was **743/743** for note-level feature vectors and **742/742** for eligible raw-reading groups. This checks implementation agreement, not classification accuracy or performance on physical ESP32 hardware. After holdout evaluation, the companion deployment model was refitted on all 743 notes.
98
 
99
+ These results describe the recorded sensor setup and acquisition conditions; they do not establish performance under unmeasured banknote wear, lighting, orientation, or hardware variations.
100
 
101
+ ## Intended Uses
102
 
103
+ - Banknote denomination recognition.
104
+ - Embedded machine learning and RGBC sensor classification.
105
+ - Assistive currency-recognition research.
106
+ - Feature engineering and acquisition-sequence analysis.
107
+ - Leakage-free, physical-banknote-aware model evaluation.
 
108
 
109
  ## Out-of-Scope Uses
110
 
111
+ - Counterfeit detection or banknote authentication.
112
+ - Financial security verification.
113
+ - Banknote valuation.
 
 
 
114
 
115
  ## License
116
 
117
+ The dataset is licensed under the **Creative Commons Attribution 4.0 International (CC BY 4.0)** license. Software code, if distributed, should have its own explicitly stated license.
118
 
119
  ## Citation
120
 
121
+ The permanent dataset DOI and associated data-paper citation will be added after publication.
122
 
123
  ## Dataset Version
124
 
125
+ **Version 2.0 (release candidate):** Seven-denomination update including `2000.csv`. Version and citation details should be finalized with the published dataset record.