Improve dataset card

#6
by davanstrien HF Staff - opened
Files changed (1) hide show
  1. README.md +24 -148
README.md CHANGED
@@ -71,164 +71,48 @@ configs:
71
  path: data/train-*
72
  ---
73
 
 
74
 
75
- The Dataset contains images derived from the [Newspaper Navigator](https://news-navigator.labs.loc.gov/), a dataset of images drawn from the Library of Congress Chronicling America collection (chroniclingamerica.loc.gov/).
76
 
77
- > [The Newspaper Navigator dataset](https://news-navigator.labs.loc.gov/) consists of extracted visual content for 16,358,041 historic newspaper pages in Chronicling America. The visual content was identified using an object detection model trained on annotations of World War 1-era Chronicling America pages, including annotations made by volunteers as part of the Beyond Words crowdsourcing project. source: https://news-navigator.labs.loc.gov/
78
 
79
- One of these categories is 'advertisements'. This dataset contains a sample of these images with additional labels indicating if the advert is 'illustrated' or 'not illustrated'.
80
 
81
- This dataset was created for use in a [Programming Historian tutorial](http://programminghistorian.github.io/ph-submissions/lessons/computer-vision-deep-learning-pt1). The primary aim of the data was to provide a realistic example dataset for teaching computer vision for working with digitised heritage material.
82
 
 
 
 
 
83
 
84
- # Dataset Card for 19th Century United States Newspaper Advert images with 'illustrated' or 'non illustrated' labels
85
 
86
- ## Table of Contents
87
- - [Table of Contents](#table-of-contents)
88
- - [Dataset Description](#dataset-description)
89
- - [Dataset Summary](#dataset-summary)
90
- - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
91
- - [Languages](#languages)
92
- - [Dataset Structure](#dataset-structure)
93
- - [Data Instances](#data-instances)
94
- - [Data Fields](#data-fields)
95
- - [Data Splits](#data-splits)
96
- - [Dataset Creation](#dataset-creation)
97
- - [Curation Rationale](#curation-rationale)
98
- - [Source Data](#source-data)
99
- - [Annotations](#annotations)
100
- - [Personal and Sensitive Information](#personal-and-sensitive-information)
101
- - [Considerations for Using the Data](#considerations-for-using-the-data)
102
- - [Social Impact of Dataset](#social-impact-of-dataset)
103
- - [Discussion of Biases](#discussion-of-biases)
104
- - [Other Known Limitations](#other-known-limitations)
105
- - [Additional Information](#additional-information)
106
- - [Dataset Curators](#dataset-curators)
107
- - [Licensing Information](#licensing-information)
108
- - [Citation Information](#citation-information)
109
- - [Contributions](#contributions)
110
 
111
- ## Dataset Description
112
 
113
- - **Homepage:**
114
- - **Repository:**[https://doi.org/10.5281/zenodo.5838410](https://doi.org/10.5281/zenodo.5838410)
115
- - **Paper:**[https://doi.org/10.46430/phen0101](https://doi.org/10.46430/phen0101)
116
- - **Leaderboard:**
117
- - **Point of Contact:**
118
 
119
- ### Dataset Summary
120
 
121
- The Dataset contains images derived from the [Newspaper Navigator](news-navigator.labs.loc.gov/), a dataset of images drawn from the Library of Congress Chronicling America collection (chroniclingamerica.loc.gov/).
122
 
123
- > [The Newspaper Navigator dataset](https://news-navigator.labs.loc.gov/) consists of extracted visual content for 16,358,041 historic newspaper pages in Chronicling America. The visual content was identified using an object detection model trained on annotations of World War 1-era Chronicling America pages, including annotations made by volunteers as part of the Beyond Words crowdsourcing project. source: https://news-navigator.labs.loc.gov/
124
 
125
- One of these categories is 'advertisements. This dataset contains a sample of these images with additional labels indicating if the advert is 'illustrated' or 'not illustrated'.
126
 
127
- This dataset was created for use in a [Programming Historian tutorial](http://programminghistorian.github.io/ph-submissions/lessons/computer-vision-deep-learning-pt1). The primary aim of the data was to provide a realistic example dataset for teaching computer vision for working with digitised heritage material.
128
 
 
 
129
 
130
- ### Supported Tasks and Leaderboards
131
-
132
- - `image-classification`: the primary purpose of this dataset is for classifying historic newspaper images identified as being 'advertisements' into 'illustrated' and 'not-illustrated' categories.
133
-
134
- ### Languages
135
-
136
- [More Information Needed]
137
-
138
- ## Dataset Structure
139
-
140
- ### Data Instances
141
-
142
- An example instance from this dataset
143
-
144
- ``` python
145
- {'file': 'pst_fenske_ver02_data_sn84026497_00280776129_1880042101_0834_002_6_96.jpg',
146
- 'image': <PIL.JpegImagePlugin.JpegImageFile image mode=L size=388x395 at 0x7F9A72038950>,
147
- 'label': 0,
148
- 'pub_date': Timestamp('1880-04-21 00:00:00'),
149
- 'page_seq_num': 834,
150
- 'edition_seq_num': 1,
151
- 'batch': 'pst_fenske_ver02',
152
- 'lccn': 'sn84026497',
153
- 'box': [0.649412214756012,
154
- 0.6045778393745422,
155
- 0.8002520799636841,
156
- 0.7152365446090698],
157
- 'score': 0.9609346985816956,
158
- 'ocr': "H. II. IIASLKT & SOXN, Dealers in General Merchandise In New Store Room nt HASLET'S COS ITERS, 'JTionoMtii, ln. .Tau'y 1st, 1?0.",
159
- 'place_of_publication': 'Tionesta, Pa.',
160
- 'geographic_coverage': "['Pennsylvania--Forest--Tionesta']",
161
- 'name': 'The Forest Republican. [volume]',
162
- 'publisher': 'Ed. W. Smiley',
163
- 'url': 'https://news-navigator.labs.loc.gov/data/pst_fenske_ver02/data/sn84026497/00280776129/1880042101/0834/002_6_96.jpg',
164
- 'page_url': 'https://chroniclingamerica.loc.gov/data/batches/pst_fenske_ver02/data/sn84026497/00280776129/1880042101/0834.jp2'}
165
  ```
166
- ### Data Fields
167
-
168
- [More Information Needed]
169
-
170
- ### Data Splits
171
-
172
- The dataset contains a single split.
173
-
174
- ## Dataset Creation
175
-
176
- ### Curation Rationale
177
-
178
- [More Information Needed]
179
-
180
- ### Source Data
181
-
182
- #### Initial Data Collection and Normalization
183
-
184
- [More Information Needed]
185
-
186
- #### Who are the source language producers?
187
-
188
- [More Information Needed]
189
-
190
- ### Annotations
191
-
192
- #### Annotation process
193
-
194
- A description of the annotation process is outlined in this [GitHub repository](https://github.com/Living-with-machines/nnanno)
195
- [More Information Needed]
196
-
197
- #### Who are the annotators?
198
 
199
- [More Information Needed]
200
-
201
- ### Personal and Sensitive Information
202
-
203
- [More Information Needed]
204
-
205
- ## Considerations for Using the Data
206
-
207
- ### Social Impact of Dataset
208
-
209
- [More Information Needed]
210
-
211
- ### Discussion of Biases
212
-
213
- [More Information Needed]
214
-
215
- ### Other Known Limitations
216
-
217
- [More Information Needed]
218
-
219
- ## Additional Information
220
-
221
- ### Dataset Curators
222
-
223
- [More Information Needed]
224
-
225
- ### Licensing Information
226
-
227
- [More Information Needed]
228
-
229
- ### Citation Information
230
-
231
- ``` bibtex
232
  @dataset{van_strien_daniel_2021_5838410,
233
  author = {van Strien, Daniel},
234
  title = {{19th Century United States Newspaper Advert images
@@ -239,12 +123,4 @@ A description of the annotation process is outlined in this [GitHub repository](
239
  version = {0.0.1},
240
  doi = {10.5281/zenodo.5838410},
241
  url = {https://doi.org/10.5281/zenodo.5838410}}
242
-
243
  ```
244
-
245
-
246
- [More Information Needed]
247
-
248
- ### Contributions
249
-
250
- Thanks to [@davanstrien](https://github.com/davanstrien) for adding this dataset.
 
71
  path: data/train-*
72
  ---
73
 
74
+ # 19th Century US Newspaper Adverts — illustrated or text-only
75
 
76
+ 549 advertisement images cut from digitised United States newspaper pages in the Library of Congress [Chronicling America](https://chroniclingamerica.loc.gov/) collection, each labelled `text-only` or `illustrations`. The adverts were located by [Newspaper Navigator](https://news-navigator.labs.loc.gov/) (LC Labs), which ran an object detection model over 16,358,041 Chronicling America pages to extract visual content; advertisements are one of its categories.
77
 
78
+ The sample is even by year, not by title: 61 adverts from each of nine years at five-year intervals, 1860–1900, drawn from 301 newspaper titles across 245 places of publication. Sampling and annotation used [nnanno](https://github.com/Living-with-machines/nnanno).
79
 
80
+ It was built as teaching data for the Programming Historian lesson *Computer Vision for the Humanities* ([10.46430/phen0101](https://doi.org/10.46430/phen0101)) a realistic rather than clean example for teaching image classification on digitised heritage material.
81
 
82
+ ## Labels
83
 
84
+ | label | count |
85
+ |---|---|
86
+ | `text-only` | 376 |
87
+ | `illustrations` | 173 |
88
 
89
+ Roughly 2:1, so accuracy is a weak metric here report per-class scores.
90
 
91
+ ## Structure
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
92
 
93
+ One `train` split, no train/test division. Each row carries the cropped advert (`image`), the `label`, OCR text for the advert region (`ocr`), the detection box on the source page as relative coordinates (`box`) and its confidence (`score`), plus Chronicling America metadata: `pub_date`, `lccn`, `name`, `publisher`, `place_of_publication`, `geographic_coverage`, `batch`, `page_seq_num`, `edition_seq_num`, `file`, and `url` / `page_url` pointing back to the source crop and full page scan.
94
 
95
+ > [!WARNING]
96
+ > The images are single-channel greyscale (PIL mode `L`). Call `.convert("RGB")` before feeding them to a pretrained backbone.
 
 
 
97
 
98
+ Two further traps. Every row has `score` ≥ 0.90 (range 0.900–0.998), so adverts the detector found ambiguous never entered the sample — this data is easier than the page collection it came from. And `ocr` is raw Chronicling America OCR of the crop: noisy throughout, and empty for 21 of the 549 rows.
99
 
100
+ ## Uses and limits
101
 
102
+ Binary image classification, transfer-learning walkthroughs, and a small test bed for how the illustrated/text-only split changes across 1860–1900. At 549 rows it is too small to support claims about the 19th-century press: the 301 titles here are the ones Chronicling America has digitised, and that programme selects title by title through state partners.
103
 
104
+ ## Licence and citation
105
 
106
+ Public domain (CC0-1.0), per the [Zenodo deposit](https://doi.org/10.5281/zenodo.5838410); the underlying page scans are US public domain material held by the Library of Congress. The Zenodo record credits Daniel van Strien (British Library) as author and Catherine Bond-Harris as data collector.
107
 
108
+ ```python
109
+ from datasets import load_dataset
110
 
111
+ ds = load_dataset("biglam/illustrated_ads", split="train") # 549 rows, ~48 MB
112
+ image = ds[0]["image"].convert("RGB")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
114
 
115
+ ```bibtex
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
116
  @dataset{van_strien_daniel_2021_5838410,
117
  author = {van Strien, Daniel},
118
  title = {{19th Century United States Newspaper Advert images
 
123
  version = {0.0.1},
124
  doi = {10.5281/zenodo.5838410},
125
  url = {https://doi.org/10.5281/zenodo.5838410}}
 
126
  ```