data-monkey commited on
Commit
687c649
·
verified ·
1 Parent(s): 5f60637

Update README.md

Browse files

updated with new OCR outputs and adjusted field types

Files changed (1) hide show
  1. README.md +41 -17
README.md CHANGED
@@ -76,6 +76,8 @@ dataset_info:
76
  - [Data Collection and Processing](#data-collection-and-processing)
77
  - [Processing Steps](#processing-steps)
78
  - [Supporting Files Available](#supporting-files-available)
 
 
79
  - [Quality Considerations](#quality-considerations)
80
  - [Dataset Structure](#dataset-structure)
81
  - [Data Fields](#data-fields)
@@ -101,7 +103,7 @@ dataset_info:
101
  - [Dataset Card Contact](#dataset-card-contact)
102
 
103
  ## Dataset Summary
104
- A dataset drawn from the Library of Congress Chronicling America digital collection, part of the National Digital Newspaper Program (NDNP). This dataset includes page-level records with images, OCR text, and publication metadata for newspapers published between 1770 and 1810. It provides a foundation for research, machine learning, and public history projects in honor of the 250th anniversary of the United States.
105
 
106
  ## Dataset Description
107
  For the initiative *Revolution Crossroads*, the Smithsonian Institution prepared this dataset using data, metadata, and digital objects publicly available from the Chronicling America digital collection.
@@ -165,6 +167,23 @@ PDF versions of each page image are available in the Files tab:
165
  - "media" contains the pdf source files for the records from the dataset, stored in directories for each of newspaper lccns (title series numbers). The file naming convention is "[issue_date]_[edition_order]_[page].pdf".
166
  -- please note, the jpeg2000 files, available via the links in the dataset, are of a higher resolution than the pdfs.
167
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
168
  ### Accessing a Specific Data Version
169
 
170
  This dataset may be updated over time as source data is revised,
@@ -200,11 +219,11 @@ to either a pandas or Polars dataframe for analysis.
200
 
201
  #### Available Data Versions
202
 
203
- - [`Source_2025-08-01`](https://huggingface.co/datasets/RevolutionCrossroads/loc_chronicling_america_1770-1810/tree/Source_2025-08-01)
204
- - [`Source_2026-05-18`](https://huggingface.co/datasets/RevolutionCrossroads/loc_chronicling_america_1770-1810/tree/Source_2026-05-18)
 
205
 
206
- Using a tagged version is recommended for research, publication, or
207
- project workflows where consistency over time is important.
208
 
209
  ### Quality Considerations
210
  - OCR accuracy varies depending on print quality, typography, and page condition
@@ -219,21 +238,21 @@ Each record in the dataset corresponds to a single newspaper page. Issue-level m
219
 
220
  ### Core Identifiers
221
 
222
- - **Web_URL** *(string)*
223
  URL to the newspaper issue or page in Chronicling America.
224
  *Example:* `[https://www.loc.gov/item/sn82016139/1776-07-15/ed-1/](https://www.loc.gov/item/sn82016139/1776-07-15/ed-1/)`
225
 
226
- - **lccn** *(string)*
227
  Library of Congress Control Number for the newspaper title.
228
  *Example:* `sn83045110`
229
 
230
- - **newspaper_title** *(string)*
231
  Title of the newspaper.
232
  *Example:* `The Pennsylvania Packet, and Daily Advertiser`
233
 
234
  ### Publication Metadata
235
 
236
- - **place_of_publication** *(string)*
237
  City and state of publication.
238
  *Example:* `Philadelphia, Pennsylvania`
239
 
@@ -253,33 +272,38 @@ Page number within the issue.
253
 
254
  ### Media Fields
255
 
256
- - **thumbnail_url** *(string)*
257
  URL to a thumbnail image of the page.
258
  *Example:*
259
  `https://tile.loc.gov/image-services/iiif/service:sgp:sgpbatches:misctop:batch_dlc_misctopsn82016139_ver01:data:sn82016139:print:1776071501:0004/full/pct:6.25/0/default.jpg#h=318&w=202`
260
 
261
- - **jpeg2000_url** *(string)*
262
  URL to the high-resolution JPEG2000 page image. This is the highest-resolution image link included in the dataset and is recommended for users working with page images.
263
  *Example:*
264
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809070801/0074.jp2`
265
 
266
- - **pdf_url** *(string)*
267
  URL to the PDF of the page.
268
  *Example:*
269
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809071201/0079.pdf`
270
 
271
- - **ocr_url** *(string)*
272
- URL to the ALTOXML OCR file for the page.
273
  *Example:*
274
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809071201/0079.xml`
275
 
276
  ### Extracted Text (OCR)
277
 
278
- - **ocr_text** *(string)*
279
- OCR text extracted from the page image. Present for all records.
280
  *Example excerpt:*
281
  `"In CONGRESS, July 4, 1776. A DECLARATION by the Representatives of the UNITED STATES OF AMERICA..."`
282
 
 
 
 
 
 
283
  ### Record Creation
284
 
285
  - **source_record_creation_date** *(timestamp[ns])*
@@ -327,7 +351,7 @@ Metadata and digitized content are updated by the Library of Congress on an ongo
327
 
328
 
329
  ### Recommendations
330
- Researchers should validate extracted information against images when accuracy is critical, and be cautious about treating OCR text as complete or authoritative. Consultation of the Chronicling America collection is recommended for the most up-to-date records.
331
 
332
  ## Additional Information
333
 
 
76
  - [Data Collection and Processing](#data-collection-and-processing)
77
  - [Processing Steps](#processing-steps)
78
  - [Supporting Files Available](#supporting-files-available)
79
+ - [Accessing a Specific Data Version](#accessing-a-specific-data-version)
80
+ - [AI OCR Enrichment](#ai-ocr-enrichment)
81
  - [Quality Considerations](#quality-considerations)
82
  - [Dataset Structure](#dataset-structure)
83
  - [Data Fields](#data-fields)
 
103
  - [Dataset Card Contact](#dataset-card-contact)
104
 
105
  ## Dataset Summary
106
+ A dataset drawn from the Library of Congress Chronicling America digital collection, part of the National Digital Newspaper Program (NDNP). This dataset includes page-level records with images, original Chronicling America OCR, AI-generated OCR, and publication metadata for newspapers published between 1770 and 1810. It provides a foundation for research, machine learning, and public history projects in honor of the 250th anniversary of the United States.
107
 
108
  ## Dataset Description
109
  For the initiative *Revolution Crossroads*, the Smithsonian Institution prepared this dataset using data, metadata, and digital objects publicly available from the Chronicling America digital collection.
 
167
  - "media" contains the pdf source files for the records from the dataset, stored in directories for each of newspaper lccns (title series numbers). The file naming convention is "[issue_date]_[edition_order]_[page].pdf".
168
  -- please note, the jpeg2000 files, available via the links in the dataset, are of a higher resolution than the pdfs.
169
 
170
+ ### AI OCR Enrichment
171
+
172
+ This dataset has been enriched with AI-generated OCR produced using **DataLab's Chandra OCR 2**, a Vision Language Model (VLM) for document understanding.
173
+
174
+ Complete Chandra OCR 2 processing outputs are stored in the **Revolution Crossroads VLM OCR** Hugging Face bucket. The bucket includes a README describing the processing pipeline, output formats, and directory structure.
175
+
176
+ - **Complete VLM OCR Bucket:** [RevolutionCrossroads_VLM_OCR](https://huggingface.co/buckets/RevolutionCrossroads/RevolutionCrossroads_VLM_OCR)
177
+ - **Chronicling America:** [chronicling_america](https://huggingface.co/buckets/RevolutionCrossroads/RevolutionCrossroads_VLM_OCR/tree/chronicling_america)
178
+
179
+ One additional field has been added:
180
+
181
+ - **RevX_OCR_text** contains plain text extracted from the page using Chandra OCR 2. This field supplements the original Chronicling America OCR (`ca_ocr_text`) and is provided to support downstream analysis and comparison of OCR methods.
182
+
183
+ These outputs represent the direct results of automated AI processing. They have **not** been manually validated or corrected and should be treated as machine-generated data.
184
+
185
+ Not every record in this dataset currently includes Chandra OCR 2 outputs. Initial processing was completed in **March 2026**. Since then, the source collections have been refreshed with additional materials. A second round of Chandra OCR 2 processing is currently underway, and additional processing outputs will be incorporated into future dataset releases.
186
+
187
  ### Accessing a Specific Data Version
188
 
189
  This dataset may be updated over time as source data is revised,
 
219
 
220
  #### Available Data Versions
221
 
222
+ - [`Source_2025-08-01`](https://huggingface.co/datasets/RevolutionCrossroads/loc_chronicling_america_1770-1810/tree/Source_2025-08-01) – Initial source data.
223
+ - [`Source_2026-05-18`](https://huggingface.co/datasets/RevolutionCrossroads/loc_chronicling_america_1770-1810/tree/Source_2026-05-18) – Updated source data, including the full year 1810, newly contributed issues, and revised metadata.
224
+ - [`new_OCR_v1`](https://huggingface.co/datasets/RevolutionCrossroads/loc_chronicling_america_1770-1810/tree/new_OCR_v1) – Adds AI-generated Chandra OCR 2 (`RevX_OCR_text`) while preserving the page-level dataset structure.
225
 
226
+ Using a tagged version is recommended for research, publication, or project workflows where consistency over time is important.
 
227
 
228
  ### Quality Considerations
229
  - OCR accuracy varies depending on print quality, typography, and page condition
 
238
 
239
  ### Core Identifiers
240
 
241
+ - **Web_URL** *(large_string)*
242
  URL to the newspaper issue or page in Chronicling America.
243
  *Example:* `[https://www.loc.gov/item/sn82016139/1776-07-15/ed-1/](https://www.loc.gov/item/sn82016139/1776-07-15/ed-1/)`
244
 
245
+ - **lccn** *(large_string)*
246
  Library of Congress Control Number for the newspaper title.
247
  *Example:* `sn83045110`
248
 
249
+ - **newspaper_title** *(large_string)*
250
  Title of the newspaper.
251
  *Example:* `The Pennsylvania Packet, and Daily Advertiser`
252
 
253
  ### Publication Metadata
254
 
255
+ - **place_of_publication** *(large_string)*
256
  City and state of publication.
257
  *Example:* `Philadelphia, Pennsylvania`
258
 
 
272
 
273
  ### Media Fields
274
 
275
+ - **thumbnail_url** *(large_string)*
276
  URL to a thumbnail image of the page.
277
  *Example:*
278
  `https://tile.loc.gov/image-services/iiif/service:sgp:sgpbatches:misctop:batch_dlc_misctopsn82016139_ver01:data:sn82016139:print:1776071501:0004/full/pct:6.25/0/default.jpg#h=318&w=202`
279
 
280
+ - **jpeg2000_url** *(large_string)*
281
  URL to the high-resolution JPEG2000 page image. This is the highest-resolution image link included in the dataset and is recommended for users working with page images.
282
  *Example:*
283
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809070801/0074.jp2`
284
 
285
+ - **pdf_url** *(large_string)*
286
  URL to the PDF of the page.
287
  *Example:*
288
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809071201/0079.pdf`
289
 
290
+ - **ca_ocr_url** *(string)*
291
+ URL to the ALTO XML OCR file for the page, as provided by the contributing institution through Chronicling America.
292
  *Example:*
293
  `https://tile.loc.gov/storage-services/service/ndnp/deu/batch_deu_kedavra_ver01/data/sn82014385/00271740232/1809071201/0079.xml`
294
 
295
  ### Extracted Text (OCR)
296
 
297
+ - **ca_ocr_text** *(string)*
298
+ Original OCR text extracted from the page image by the contributing institution through Chronicling America. Present for all records.
299
  *Example excerpt:*
300
  `"In CONGRESS, July 4, 1776. A DECLARATION by the Representatives of the UNITED STATES OF AMERICA..."`
301
 
302
+ - **RevX_OCR_text** *(large_string)*
303
+ Plain text extracted from the page image using DataLab's Chandra OCR 2 Vision Language Model (VLM). This field contains machine-generated OCR intended to supplement the original Chronicling America OCR. May be null if the page has not yet been processed.
304
+ *Example excerpt:*
305
+ `"THE DELAWARE GAZETTE. VOL. I. WILMINGTON..."`
306
+
307
  ### Record Creation
308
 
309
  - **source_record_creation_date** *(timestamp[ns])*
 
351
 
352
 
353
  ### Recommendations
354
+ Researchers should validate extracted information against images when accuracy is critical, and be cautious about treating OCR text as complete or authoritative. Users should also distinguish between the original Chronicling America OCR (`ca_ocr_text`) and the AI-generated Chandra OCR 2 outputs (`RevX_OCR_text`) when conducting analyses. Consultation of the Chronicling America collection is recommended for the most up-to-date records.
355
 
356
  ## Additional Information
357