Squashing commit

.gitattributes

@@ -0,0 +1,59 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mds filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,209 @@
+---
+dataset_info:
+  features:
+  - name: document_id
+    dtype: string
+  - name: page_number
+    dtype: int32
+  - name: file_identifier
+    dtype: string
+  - name: image
+    dtype: image
+  - name: text
+    dtype: string
+  - name: alto_xml
+    dtype: string
+  - name: has_image
+    dtype: bool
+  - name: has_alto
+    dtype: bool
+  - name: document_metadata
+    dtype: string
+  - name: has_metadata
+    dtype: bool
+  - name: exam_type
+    dtype: string
+  - name: exam_year
+    dtype: string
+  - name: exam_reference
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1646707701.999
+    num_examples: 11141
+  download_size: 1403366547
+  dataset_size: 1646707701.999
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+license: cc0-1.0
+task_categories:
+- text-generation
+language:
+- en
+tags:
+- ocr
+---
+
+# Scottish School Exam Papers Dataset
+
+## Dataset Description
+
+This dataset contains digitised Scottish school examination papers from the National Library of Scotland's (NLS) digital collections. The papers represent historical educational assessment materials that have been processed with Optical Character Recognition (OCR) to extract text content alongside the original page images.
+
+### Dataset Summary
+
+- **Source**: [National Library of Scotland - Scottish School Exam Papers](https://data.nls.uk/data/digitised-collections/scottish-exams/)
+- **Format**: Image-text pairs with OCR output
+- **Processing**: Converted from ALTO XML and JPG images to Hugging Face dataset format
+- **Contents**: Historical Scottish school examination papers with both scanned images and extracted text
+
+## Dataset Structure
+
+### Data Fields
+
+Each record in the dataset contains the following fields:
+
+- `document_id` (string): Unique identifier for the exam paper document
+- `page_number` (string): Page number within the document
+- `image` (image): Scanned image of the exam paper page
+- `text` (string): OCR-extracted text from the page
+- `alto_xml` (string): Raw ALTO XML containing detailed OCR information
+- `has_image` (bool): Whether the page has an associated image file
+- `has_alto` (bool): Whether the page has associated ALTO OCR data
+- `document_metadata` (string): Additional metadata about the document (if available)
+- `has_metadata` (bool): Whether metadata is available for this document
+
+### Data Statistics
+
+The dataset includes examination papers with varying levels of OCR quality and completeness. Some pages may have images without corresponding OCR text, typically due to:
+- Poor scan quality
+- Handwritten content
+- Complex layouts or mathematical notation
+- Degraded original documents
+
+## Usage
+
+### Loading the Dataset
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("davanstrien/Scottish-School-Exam-Papers")
+
+# Access the data
+for example in dataset['train']:
+    print(f"Document: {example['document_id']}")
+    print(f"Page: {example['page_number']}")
+    print(f"Text preview: {example['text'][:200]}...")
+    # Display image if needed
+    example['image'].show()
+    break
+```
+
+### Filtering for Complete Records
+
+To work only with pages that have both images and OCR text:
+
+```python
+# Filter for complete records
+complete_pages = dataset.filter(lambda x: x['has_image'] and x['has_alto'])
+print(f"Complete pages: {len(complete_pages)}")
+```
+
+### Working with ALTO XML
+
+The ALTO XML contains detailed OCR information including:
+- Text positioning and layout
+- Confidence scores
+- Character-level bounding boxes
+
+```python
+import xml.etree.ElementTree as ET
+
+# Parse ALTO XML for detailed OCR information
+def parse_alto_details(alto_xml):
+    root = ET.fromstring(alto_xml)
+    ns = {'alto': 'http://www.loc.gov/standards/alto/v3/alto.xsd'}
+    
+    # Extract text lines with positioning
+    for textline in root.findall('.//alto:TextLine', ns):
+        line_text = []
+        for string_elem in textline.findall('./alto:String', ns):
+            content = string_elem.get('CONTENT', '')
+            if content:
+                line_text.append(content)
+        if line_text:
+            print(' '.join(line_text))
+```
+
+## Dataset Creation
+
+### Source Data
+
+The original data comes from the National Library of Scotland's digitization efforts to preserve historical Scottish educational materials. The exam papers represent various subjects, years, and educational levels from Scotland's educational history.
+
+### Processing Pipeline
+
+1. **Original Format**: The source data consists of:
+   - High-resolution JPG scans of exam papers
+   - ALTO XML files containing OCR output
+   - METS metadata files
+
+2. **Conversion Process**: Using the custom conversion script:
+   - Paired image files with their corresponding ALTO XML
+   - Extracted plain text from ALTO XML while preserving line breaks
+   - Maintained document structure and page ordering
+   - Preserved metadata associations where available
+
+## Considerations for Using this Data
+
+### Historical Context
+These examination papers represent historical educational practices and may contain:
+- Outdated terminology or perspectives
+- Historical biases in educational content
+- References to historical events and contexts
+
+### OCR Quality
+The quality of text extraction varies based on:
+- Original document condition
+- Print quality and typography
+- Presence of handwritten annotations
+- Mathematical or scientific notation
+
+### Recommended Use Cases
+- Historical education research
+- OCR system evaluation and improvement
+- Educational content analysis
+- Digital humanities research
+- Training data for historical document processing
+
+## Additional Information
+
+### Licensing
+Please refer to the [National Library of Scotland's terms of use](https://data.nls.uk/data/digitised-collections/scottish-exams/) for the original data. Users should comply with NLS's licensing terms when using this dataset.
+
+### Citation
+If you use this dataset, please cite both the original source and this Hugging Face dataset:
+
+```bibtex
+@misc{nls_scottish_exams,
+  title={Scottish School Exam Papers},
+  author={National Library of Scotland},
+  howpublished={\url{https://data.nls.uk/data/digitised-collections/scottish-exams/}},
+}
+
+@misc{scottish_exams_hf,
+  title={Scottish School Exam Papers - Hugging Face Dataset},
+  author={van Strien, Daniel},
+  year={2024},
+  publisher={Hugging Face},
+  howpublished={\url{https://huggingface.co/datasets/davanstrien/Scottish-School-Exam-Papers}},
+}
+```
+
+### Acknowledgments
+Dataset converted to Hugging Face format by [davanstrien](https://huggingface.co/davanstrien)

data/train-00000-of-00004.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:778083d11a29fed9fd702be7f0cfbababac5f2d80d912375d6973f3e30cf95ee
+size 324515729

data/train-00001-of-00004.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0d91afba9d4f8bc64e35d28ecf097aed0bac1d4c9d117f0fb7b08427efe69707
+size 376902182

data/train-00002-of-00004.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:01522d14bd9963b17d7b1b667efbd312fa72b1030d036a3116003e20324727ca
+size 333495540

data/train-00003-of-00004.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3a448c2e199ff36f786a1bc2742c89cd43f35ada06715ae5eabbe6347abf4354
+size 368453096