Azzindani commited on
Commit
fd63821
Β·
verified Β·
1 Parent(s): 5aa7ee3

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +18 -10
README.md CHANGED
@@ -5,7 +5,7 @@ license: apache-2.0
5
 
6
  # πŸ“„ Invoice Image Dataset (N8N-Friendly Streaming Format)
7
 
8
- This repository contains a large-scale collection of invoice images stored in a **simple, sequential, machine-friendly structure** designed specifically for workflow automation tools such as **n8n**, Airflow, Make.com, and other ETL/automation systems.
9
 
10
  The dataset is formatted to allow **easy, reliable, and high-performance pulling of individual invoice files one-by-one**, without needing to download the entire dataset.
11
 
@@ -13,16 +13,24 @@ The dataset is formatted to allow **easy, reliable, and high-performance pulling
13
 
14
  ## πŸ“ Directory Structure
15
 
16
- All invoice images are stored inside a single directory:
17
 
18
  ```
19
- images/
20
  β”‚
21
  β”œβ”€β”€ invoice_00000001.png
22
  β”œβ”€β”€ invoice_00000002.png
23
  β”œβ”€β”€ invoice_00000003.png
24
  β”œβ”€β”€ invoice_00000004.png
25
  └── ...
 
 
 
 
 
 
 
 
26
  ```
27
 
28
  ### βœ… Naming Format
@@ -41,11 +49,11 @@ invoice_00000000.format
41
 
42
  ## 🎯 Purpose of This Dataset
43
 
44
- This dataset acts as a **normalized, unified output repository** for invoice images collected and standardized from multiple sources:
45
 
46
  * Other Hugging Face datasets
47
  * GitHub repositories
48
- * Parquet datasets containing embedded images
49
  * Third-party OCR datasets
50
  * Custom pipelines
51
 
@@ -58,7 +66,7 @@ Each invoice is extracted, normalized, renamed, and uploaded in a consistent str
58
  Most automation tools (including **n8n**) struggle with:
59
 
60
  * datasets stored in large compressed files (ZIPs, JSONL, Parquet)
61
- * datasets where images must be decoded from arrays/blobs
62
  * datasets requiring full-dataset downloads
63
 
64
  This repo is intentionally built to support **file-by-file streaming**, so n8n can:
@@ -68,7 +76,7 @@ This repo is intentionally built to support **file-by-file streaming**, so n8n c
68
  Example URL:
69
 
70
  ```
71
- https://huggingface.co/datasets/<USER>/<REPO>/resolve/main/images/invoice_00000042.png
72
  ```
73
 
74
  ### βœ” Process invoices sequentially
@@ -100,7 +108,7 @@ You only need a simple incrementing counter in n8n.
100
  2. Construct file URL:
101
 
102
  ```
103
- url = https://huggingface.co/datasets/<USER>/<REPO>/resolve/main/images/invoice_<index padded>.png
104
  ```
105
 
106
  3. HTTP GET β†’ process invoice
@@ -117,7 +125,7 @@ This allows n8n to **stream** invoices from Hugging Face like a controlled queue
117
 
118
  ## πŸ“¦ What This Dataset Contains
119
 
120
- * Only raw invoice images
121
  * No labels
122
  * No associated OCR text
123
  * No metadata
@@ -133,7 +141,7 @@ A controlled pipeline:
133
  1. Loads invoices from multiple formats (HF dataset, Parquet, GitHub, OCR outputs, etc.)
134
  2. Extracts image data
135
  3. Converts and normalizes to `.png` or `.jpg`
136
- 4. Saves to `images/invoice_XXXXXXXX.format`
137
  5. Uploads each file individually using the Hugging Face API
138
  6. Logs progress so the job can resume at any index
139
 
 
5
 
6
  # πŸ“„ Invoice Image Dataset (N8N-Friendly Streaming Format)
7
 
8
+ This repository contains a large-scale collection of invoice data stored in a **simple, sequential, machine-friendly structure** designed specifically for workflow automation tools such as **n8n**, Airflow, Make.com, and other ETL/automation systems.
9
 
10
  The dataset is formatted to allow **easy, reliable, and high-performance pulling of individual invoice files one-by-one**, without needing to download the entire dataset.
11
 
 
13
 
14
  ## πŸ“ Directory Structure
15
 
16
+ All invoice data are stored inside a single directory:
17
 
18
  ```
19
+ data_0001/
20
  β”‚
21
  β”œβ”€β”€ invoice_00000001.png
22
  β”œβ”€β”€ invoice_00000002.png
23
  β”œβ”€β”€ invoice_00000003.png
24
  β”œβ”€β”€ invoice_00000004.png
25
  └── ...
26
+ data_0002/
27
+ β”‚
28
+ β”œβ”€β”€ invoice_00010001.png
29
+ β”œβ”€β”€ invoice_00010002.png
30
+ β”œβ”€β”€ invoice_00010003.png
31
+ β”œβ”€β”€ invoice_00010004.png
32
+ └── ...
33
+ ...
34
  ```
35
 
36
  ### βœ… Naming Format
 
49
 
50
  ## 🎯 Purpose of This Dataset
51
 
52
+ This dataset acts as a **normalized, unified output repository** for invoice data collected and standardized from multiple sources:
53
 
54
  * Other Hugging Face datasets
55
  * GitHub repositories
56
+ * Parquet datasets containing embedded data
57
  * Third-party OCR datasets
58
  * Custom pipelines
59
 
 
66
  Most automation tools (including **n8n**) struggle with:
67
 
68
  * datasets stored in large compressed files (ZIPs, JSONL, Parquet)
69
+ * datasets where data must be decoded from arrays/blobs
70
  * datasets requiring full-dataset downloads
71
 
72
  This repo is intentionally built to support **file-by-file streaming**, so n8n can:
 
76
  Example URL:
77
 
78
  ```
79
+ https://huggingface.co/datasets/<USER>/<REPO>/resolve/main/data_0001/invoice_00000042.png
80
  ```
81
 
82
  ### βœ” Process invoices sequentially
 
108
  2. Construct file URL:
109
 
110
  ```
111
+ url = https://huggingface.co/datasets/<USER>/<REPO>/resolve/main/<folder>/invoice_<index padded>.png
112
  ```
113
 
114
  3. HTTP GET β†’ process invoice
 
125
 
126
  ## πŸ“¦ What This Dataset Contains
127
 
128
+ * Only raw invoice data
129
  * No labels
130
  * No associated OCR text
131
  * No metadata
 
141
  1. Loads invoices from multiple formats (HF dataset, Parquet, GitHub, OCR outputs, etc.)
142
  2. Extracts image data
143
  3. Converts and normalizes to `.png` or `.jpg`
144
+ 4. Saves to `folder/invoice_XXXXXXXX.format`
145
  5. Uploads each file individually using the Hugging Face API
146
  6. Logs progress so the job can resume at any index
147