arvindrajan92 commited on
Commit
961d5e7
1 Parent(s): f94e1d4

Updating README

Browse files
Files changed (2) hide show
  1. .gitignore +1 -0
  2. README.md +34 -62
.gitignore ADDED
@@ -0,0 +1 @@
 
 
1
+ *.ipynb
README.md CHANGED
@@ -26,102 +26,74 @@ dataset_info:
26
  - [Table of Contents](#table-of-contents)
27
  - [Dataset Description](#dataset-description)
28
  - [Dataset Structure](#dataset-structure)
29
- - [Data Instances](#data-instances)
30
  - [Data Fields](#data-fields)
31
- - [Data Splits](#data-splits)
32
  - [Dataset Creation](#dataset-creation)
33
- - [Curation Rationale](#curation-rationale)
34
  - [Source Data](#source-data)
35
  - [Annotations](#annotations)
36
- - [Personal and Sensitive Information](#personal-and-sensitive-information)
37
- - [Considerations for Using the Data](#considerations-for-using-the-data)
38
- - [Social Impact of Dataset](#social-impact-of-dataset)
39
- - [Discussion of Biases](#discussion-of-biases)
40
- - [Other Known Limitations](#other-known-limitations)
41
  - [Additional Information](#additional-information)
42
- - [Dataset Curators](#dataset-curators)
43
  - [Licensing Information](#licensing-information)
44
- - [Citation Information](#citation-information)
45
  - [Contributions](#contributions)
46
 
47
  ## Dataset Description
48
 
49
- This dataset is an enriched version of SROIE 2019 dataset with additional labels for line descriptions and line totals for layout understanding.
50
-
51
- [More Information Needed]
52
 
53
  ## Dataset Structure
54
 
55
- ### Data Instances
56
-
57
- [More Information Needed]
 
 
 
 
 
58
 
59
  ### Data Fields
60
 
61
- [More Information Needed]
62
-
63
- ### Data Splits
64
-
65
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
 
67
  ## Dataset Creation
68
 
69
- ### Curation Rationale
70
-
71
- [More Information Needed]
72
-
73
  ### Source Data
74
 
75
- #### Initial Data Collection and Normalization
76
-
77
- [More Information Needed]
78
-
79
- #### Who are the source language producers?
80
-
81
- [More Information Needed]
82
 
83
  ### Annotations
84
 
85
  #### Annotation process
86
 
87
- [More Information Needed]
88
 
89
  #### Who are the annotators?
90
 
91
- [More Information Needed]
92
-
93
- ### Personal and Sensitive Information
94
-
95
- [More Information Needed]
96
-
97
- ## Considerations for Using the Data
98
-
99
- ### Social Impact of Dataset
100
-
101
- [More Information Needed]
102
-
103
- ### Discussion of Biases
104
-
105
- [More Information Needed]
106
-
107
- ### Other Known Limitations
108
-
109
- [More Information Needed]
110
 
111
  ## Additional Information
112
 
113
- ### Dataset Curators
114
-
115
- [More Information Needed]
116
-
117
  ### Licensing Information
118
 
119
- [More Information Needed]
120
-
121
- ### Citation Information
122
-
123
- [More Information Needed]
124
 
125
  ### Contributions
126
 
127
- Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.
 
26
  - [Table of Contents](#table-of-contents)
27
  - [Dataset Description](#dataset-description)
28
  - [Dataset Structure](#dataset-structure)
 
29
  - [Data Fields](#data-fields)
 
30
  - [Dataset Creation](#dataset-creation)
 
31
  - [Source Data](#source-data)
32
  - [Annotations](#annotations)
 
 
 
 
 
33
  - [Additional Information](#additional-information)
 
34
  - [Licensing Information](#licensing-information)
 
35
  - [Contributions](#contributions)
36
 
37
  ## Dataset Description
38
 
39
+ This dataset is an enriched version of SROIE 2019 dataset with additional labels for line descriptions and line totals for OCR and layout understanding.
 
 
40
 
41
  ## Dataset Structure
42
 
43
+ ```python
44
+ DatasetDict({
45
+ train: Dataset({
46
+ features: ['image', 'ocr'],
47
+ num_rows: 652
48
+ })
49
+ })
50
+ ```
51
 
52
  ### Data Fields
53
 
54
+ ```python
55
+ {
56
+ 'image': PIL Image object,
57
+ 'ocr': [
58
+ # text box 1
59
+ {
60
+ 'box': [[float, float], [float, float], [float, float], [float, float]],
61
+ 'label': str, # "other" | "company" | "address" | "date" | "line_description" | "line_total" | "total"
62
+ 'text': str
63
+ },
64
+ ...
65
+ # text box N
66
+ {
67
+ 'box': [[float, float], [float, float], [float, float], [float, float]],
68
+ 'label': str,
69
+ 'text': str,
70
+ }
71
+ ]
72
+ }
73
+ ```
74
 
75
  ## Dataset Creation
76
 
 
 
 
 
77
  ### Source Data
78
 
79
+ The dataset was obtained from [ICDAR2019 Competition on Scanned Receipt OCR and Information Extraction](https://rrc.cvc.uab.es/?ch=13)
 
 
 
 
 
 
80
 
81
  ### Annotations
82
 
83
  #### Annotation process
84
 
85
+ Additional labels to receipt line items were added using open source [labelme](https://github.com/wkentaro/labelme) tool.
86
 
87
  #### Who are the annotators?
88
 
89
+ Arvind Rajan
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
90
 
91
  ## Additional Information
92
 
 
 
 
 
93
  ### Licensing Information
94
 
95
+ MIT License
 
 
 
 
96
 
97
  ### Contributions
98
 
99
+ Thanks to [@arvindrajan92](https://github.com/arvindrajan92) for adding this dataset.