olmocr/scripts/scan_dolmadocs.py

1224 lines
49 KiB
Python
Raw Normal View History

2025-03-26 18:26:06 +00:00
import argparse
2025-04-04 17:12:46 +00:00
import base64
import csv
import datetime
2025-03-26 18:26:06 +00:00
import json
import os
import random
import re
import sqlite3
2025-04-04 17:12:46 +00:00
import string
import tempfile
from concurrent.futures import ThreadPoolExecutor
2025-03-26 18:26:06 +00:00
from pathlib import Path
2025-04-04 19:44:54 +00:00
from typing import Any, Dict, List, Optional, Tuple
import boto3
2025-04-04 19:44:54 +00:00
import requests
2025-04-04 17:18:19 +00:00
import tinyhost
2025-03-26 18:26:06 +00:00
from tqdm import tqdm
2025-03-26 18:26:06 +00:00
from olmocr.data.renderpdf import render_pdf_to_base64webp
from olmocr.s3_utils import get_s3_bytes, parse_s3_path
2025-03-26 18:26:06 +00:00
def parse_args():
parser = argparse.ArgumentParser(description="Scan OLMO OCR workspace results and create visual samples")
parser.add_argument("workspace", help="OLMO OCR workspace path (s3://bucket/workspace)")
parser.add_argument("--pages_per_output", type=int, default=30, help="Number of pages per output file")
parser.add_argument("--repeats", type=int, default=1, help="Number of output files to generate")
parser.add_argument("--pdf_profile", help="AWS profile for accessing PDFs")
parser.add_argument("--output_dir", default="dolma_samples", help="Directory to save output HTML files")
parser.add_argument("--max_workers", type=int, default=4, help="Maximum number of worker threads")
parser.add_argument(
"--db_path",
default="~/s2pdf_url_data/d65142df-6588-4b68-a12c-d468b3761189.csv.db",
help="Path to the SQLite database containing PDF hash to URL mapping",
)
2025-04-04 17:12:46 +00:00
parser.add_argument(
"--prolific_csv",
default="prolific_codes.csv",
help="Path to save the CSV file with Prolific codes",
)
2025-04-04 19:44:54 +00:00
parser.add_argument(
"--read_results",
help="Path to a CSV file containing previously generated tinyhost links to extract annotations",
)
2025-03-26 18:26:06 +00:00
return parser.parse_args()
2025-04-04 17:12:46 +00:00
def generate_prolific_code(length=8):
"""Generate a random code for Prolific."""
characters = string.ascii_uppercase + string.digits
2025-04-04 17:18:19 +00:00
return "".join(random.choice(characters) for _ in range(length))
2025-04-04 17:12:46 +00:00
def obfuscate_code(code):
"""Gently obfuscate the Prolific code so it's not immediately visible in source."""
# Convert to base64 and reverse
encoded = base64.b64encode(code.encode()).decode()
return encoded[::-1]
def deobfuscate_code(obfuscated_code):
"""Deobfuscate the code - this will be done in JavaScript."""
# Reverse and decode from base64
reversed_encoded = obfuscated_code[::-1]
try:
return base64.b64decode(reversed_encoded).decode()
except:
return "ERROR_DECODING"
2025-03-26 18:26:06 +00:00
def parse_pdf_hash(pretty_pdf_path: str) -> Optional[str]:
pattern = r"s3://ai2-s2-pdfs/([a-f0-9]{4})/([a-f0-9]+)\.pdf"
match = re.match(pattern, pretty_pdf_path)
if match:
return match.group(1) + match.group(2)
return None
2025-03-26 18:26:06 +00:00
def get_original_url(pdf_hash: str, db_path: str) -> Optional[str]:
"""Look up the original URL for a PDF hash in the SQLite database."""
if not pdf_hash:
return None
2025-03-26 18:26:06 +00:00
try:
sqlite_db_path = os.path.expanduser(db_path)
if not os.path.exists(sqlite_db_path):
print(f"SQLite database not found at {sqlite_db_path}")
return None
2025-03-26 18:26:06 +00:00
conn = sqlite3.connect(sqlite_db_path)
cursor = conn.cursor()
2025-03-26 18:26:06 +00:00
cursor.execute("SELECT uri FROM pdf_mapping WHERE pdf_hash = ?", (pdf_hash,))
result = cursor.fetchone()
2025-03-26 18:26:06 +00:00
conn.close()
2025-03-26 18:26:06 +00:00
if result:
return result[0]
return None
except Exception as e:
print(f"Error looking up URL for PDF hash {pdf_hash}: {e}")
return None
def list_result_files(s3_client, workspace_path):
"""List all JSON result files in the workspace results directory."""
bucket, prefix = parse_s3_path(workspace_path)
results_prefix = os.path.join(prefix, "results").rstrip("/") + "/"
2025-03-26 18:26:06 +00:00
all_files = []
paginator = s3_client.get_paginator("list_objects_v2")
for page in paginator.paginate(Bucket=bucket, Prefix=results_prefix):
if "Contents" in page:
all_files.extend([f"s3://{bucket}/{obj['Key']}" for obj in page["Contents"] if obj["Key"].endswith(".jsonl") or obj["Key"].endswith(".json")])
2025-04-04 16:05:04 +00:00
if len(all_files) > 1000:
break
2025-03-26 18:26:06 +00:00
return all_files
2025-03-26 18:26:06 +00:00
def get_random_pages(s3_client, result_files, count=30):
"""Get random pages from the result files."""
random_pages = []
2025-03-26 18:26:06 +00:00
# Try to collect the requested number of pages
attempts = 0
max_attempts = count * 3 # Allow extra attempts to handle potential failures
2025-03-26 18:26:06 +00:00
while len(random_pages) < count and attempts < max_attempts:
attempts += 1
2025-03-26 18:26:06 +00:00
# Pick a random result file
if not result_files:
print("No result files found!")
break
2025-03-26 18:26:06 +00:00
result_file = random.choice(result_files)
2025-03-26 18:26:06 +00:00
try:
# Get the content of the file
content = get_s3_bytes(s3_client, result_file)
lines = content.decode("utf-8").strip().split("\n")
2025-03-26 18:26:06 +00:00
if not lines:
continue
2025-03-26 18:26:06 +00:00
# Pick a random line (which contains a complete document)
line = random.choice(lines)
doc = json.loads(line)
2025-03-26 18:26:06 +00:00
# A Dolma document has "text", "metadata", and "attributes" fields
if "text" not in doc or "metadata" not in doc or "attributes" not in doc:
print(f"Document in {result_file} is not a valid Dolma document")
continue
2025-03-26 18:26:06 +00:00
# Get the original PDF path from metadata
pdf_path = doc["metadata"].get("Source-File")
if not pdf_path:
continue
2025-03-26 18:26:06 +00:00
# Get page spans from attributes
page_spans = doc["attributes"].get("pdf_page_numbers", [])
if not page_spans:
continue
2025-03-26 18:26:06 +00:00
# Pick a random page span
page_span = random.choice(page_spans)
if len(page_span) >= 3:
# Page spans are [start_pos, end_pos, page_num]
page_num = page_span[2]
2025-03-26 18:26:06 +00:00
# Extract text for this page
start_pos, end_pos = page_span[0], page_span[1]
page_text = doc["text"][start_pos:end_pos].strip()
2025-03-26 18:26:06 +00:00
# Include the text snippet with the page info
random_pages.append((pdf_path, page_num, page_text, result_file))
2025-03-26 18:26:06 +00:00
if len(random_pages) >= count:
break
2025-03-26 18:26:06 +00:00
except Exception as e:
print(f"Error processing {result_file}: {e}")
continue
2025-03-26 18:26:06 +00:00
print(f"Found {len(random_pages)} random pages from Dolma documents")
return random_pages
def create_presigned_url(s3_client, pdf_path, expiration=3600 * 24 * 7):
2025-03-26 18:26:06 +00:00
"""Create a presigned URL for the given S3 path."""
try:
bucket, key = parse_s3_path(pdf_path)
url = s3_client.generate_presigned_url("get_object", Params={"Bucket": bucket, "Key": key}, ExpiresIn=expiration)
2025-03-26 18:26:06 +00:00
return url
except Exception as e:
print(f"Error creating presigned URL for {pdf_path}: {e}")
return None
2025-04-04 17:12:46 +00:00
def create_html_output(random_pages, pdf_s3_client, output_path, workspace_path, db_path, prolific_code, resolution=2048):
2025-03-26 18:26:06 +00:00
"""Create an HTML file with rendered PDF pages."""
2025-04-04 17:12:46 +00:00
# Obfuscate the provided Prolific code
obfuscated_code = obfuscate_code(prolific_code)
2025-04-04 17:18:19 +00:00
2025-03-26 18:26:06 +00:00
# Get current date and time for the report
current_time = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
2025-03-26 18:26:06 +00:00
html_content = f"""
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>OLMO OCR Samples</title>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
<style>
:root {{
--primary-color: #2563eb;
--secondary-color: #4b5563;
--border-color: #e5e7eb;
--bg-color: #f9fafb;
--text-color: #111827;
--text-light: #6b7280;
--card-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
2025-04-04 16:19:04 +00:00
--success-color: #10b981;
2025-03-26 18:26:06 +00:00
}}
* {{
box-sizing: border-box;
margin: 0;
padding: 0;
}}
body {{
font-family: 'Inter', sans-serif;
line-height: 1.6;
color: var(--text-color);
background-color: var(--bg-color);
padding: 2rem;
}}
.container {{
max-width: 1200px;
margin: 0 auto;
}}
header {{
margin-bottom: 2rem;
border-bottom: 1px solid var(--border-color);
padding-bottom: 1rem;
}}
header h1 {{
color: var(--primary-color);
font-size: 2rem;
margin-bottom: 0.5rem;
}}
header p {{
color: var(--secondary-color);
font-size: 1rem;
}}
.info-bar {{
background-color: white;
padding: 1rem;
border-radius: 0.5rem;
margin-bottom: 2rem;
box-shadow: var(--card-shadow);
display: flex;
justify-content: space-between;
flex-wrap: wrap;
gap: 1rem;
}}
.info-item {{
flex: 1;
min-width: 200px;
}}
.info-item h3 {{
font-size: 0.6rem;
2025-03-26 18:26:06 +00:00
color: var(--text-light);
margin-bottom: 0.25rem;
}}
.info-item p {{
font-size: 0.6rem;
2025-03-26 18:26:06 +00:00
}}
.page-grid {{
display: grid;
grid-template-columns: repeat(2, 1fr);
gap: 2rem;
}}
.page-container {{
background-color: white;
border-radius: 0.5rem;
overflow: hidden;
box-shadow: var(--card-shadow);
2025-04-04 19:38:59 +00:00
transition: all 0.3s ease;
}}
.page-container.editing {{
box-shadow: 0 0 0 3px var(--primary-color), var(--card-shadow);
2025-03-26 18:26:06 +00:00
}}
.page-info {{
padding: 1rem;
border-bottom: 1px solid var(--border-color);
}}
.page-info h2 {{
font-size: 1rem;
margin-bottom: 0.5rem;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}}
.page-info p {{
font-size: 0.875rem;
color: var(--text-light);
}}
.page-image-wrapper {{
padding: 1rem;
display: flex;
justify-content: center;
align-items: center;
background-color: #f3f4f6;
}}
.page-image {{
max-width: 100%;
height: auto;
border: 1px solid var(--border-color);
}}
.s3-link {{
padding: 1rem;
background-color: #f8fafc;
border-top: 1px solid var(--border-color);
font-size: 0.875rem;
color: var(--secondary-color);
word-break: break-all;
}}
.s3-link a {{
color: var(--primary-color);
text-decoration: none;
font-weight: 500;
}}
.s3-link a:hover {{
text-decoration: underline;
}}
2025-04-04 16:19:04 +00:00
/* Annotation elements */
.annotation-interface {{
display: none; /* Hide annotation interface by default */
margin-top: 1rem;
padding: 0.5rem;
border-top: 1px solid var(--border-color);
border-radius: 0.25rem;
background-color: #f8fafc;
}}
.annotation-interface.active {{
display: block; /* Show only the active annotation interface */
}}
/* Button group styling for connected buttons */
.btn-group {{
display: inline-flex;
margin-bottom: 0.5rem;
}}
.btn-group .toggle-button {{
padding: 0.5rem 1rem;
border: 1px solid var(--border-color);
background-color: #f8fafc;
cursor: pointer;
margin: 0;
/* Remove individual border radius so we can set unified ones */
border-radius: 0;
}}
.btn-group .toggle-button:first-child {{
border-right: none;
border-top-left-radius: 0.25rem;
border-bottom-left-radius: 0.25rem;
}}
.btn-group .toggle-button:last-child {{
border-top-right-radius: 0.25rem;
border-bottom-right-radius: 0.25rem;
}}
2025-04-04 16:19:04 +00:00
.btn-group .toggle-button:not(:first-child):not(:last-child) {{
border-right: none;
}}
.toggle-button.active {{
background-color: var(--primary-color);
color: white;
2025-04-01 18:35:04 +00:00
}}
2025-04-04 16:19:04 +00:00
.annotation-interface textarea {{
display: none; /* Hide textarea by default */
2025-04-01 18:35:04 +00:00
width: 100%;
margin-top: 0.5rem;
padding: 0.5rem;
font-size: 0.875rem;
border: 1px solid var(--border-color);
border-radius: 0.25rem;
}}
2025-04-04 16:19:04 +00:00
.annotation-status {{
display: inline-block;
margin-left: 1rem;
padding: 0.25rem 0.5rem;
border-radius: 0.25rem;
font-size: 0.75rem;
font-weight: 600;
}}
.status-complete {{
background-color: #ecfdf5;
color: var(--success-color);
2025-04-04 19:38:59 +00:00
cursor: pointer;
transition: all 0.2s ease;
}}
.status-complete:hover {{
background-color: #d1fae5;
box-shadow: 0 0 0 2px rgba(16, 185, 129, 0.3);
2025-04-04 16:19:04 +00:00
}}
.status-pending {{
background-color: #fff7ed;
color: #ea580c;
}}
.status-current {{
background-color: #eff6ff;
color: var(--primary-color);
animation: pulse 2s infinite;
}}
@keyframes pulse {{
0% {{ opacity: 0.6; }}
50% {{ opacity: 1; }}
100% {{ opacity: 0.6; }}
}}
2025-03-26 18:26:06 +00:00
.error {{
color: #dc2626;
padding: 1rem;
background-color: #fee2e2;
border-radius: 0.25rem;
}}
2025-04-04 16:19:04 +00:00
.annotation-progress {{
position: fixed;
2025-04-04 19:44:54 +00:00
bottom: 20px;
2025-04-04 16:19:04 +00:00
left: 50%;
transform: translateX(-50%);
background-color: white;
padding: 1rem;
border-radius: 0.5rem;
box-shadow: var(--card-shadow);
z-index: 100;
display: flex;
align-items: center;
gap: 1rem;
min-width: 300px;
}}
.progress-bar {{
flex-grow: 1;
height: 8px;
background-color: var(--border-color);
border-radius: 4px;
overflow: hidden;
}}
.progress-fill {{
height: 100%;
background-color: var(--primary-color);
width: 0%;
transition: width 0.3s ease;
}}
.progress-text {{
font-size: 0.875rem;
color: var(--text-light);
white-space: nowrap;
}}
.completion-message {{
display: none;
margin: 2rem auto;
padding: 1.5rem;
background-color: #ecfdf5;
border: 1px solid #A7F3D0;
border-radius: 0.5rem;
text-align: center;
color: var(--success-color);
font-weight: 600;
max-width: 500px;
}}
2025-03-26 18:26:06 +00:00
footer {{
margin-top: 3rem;
text-align: center;
color: var(--text-light);
font-size: 0.875rem;
border-top: 1px solid var(--border-color);
padding-top: 1rem;
}}
@media (max-width: 768px) {{
body {{
padding: 1rem;
}}
.page-grid {{
grid-template-columns: 1fr;
}}
}}
</style>
</head>
<body>
<div class="container">
<header>
2025-04-04 16:29:58 +00:00
<p>
<strong>Instructions: </strong>Please review each document below and mark if it contains PII (Personally identifiable information). If you cannot read it (ex. the document is not in English, or is otherwise unreadable), mark it as such.
If the document contains disturbing or graphic content, please mark that. Finally, if there is PII, type in a brief description and press Enter. Once you mark all 30 documents, the completetion code will
2025-04-04 19:44:54 +00:00
be presented. You can edit previously created annotations on the same page.
2025-04-04 16:29:58 +00:00
</p>
<div style="display: flex; font-family: Arial, sans-serif; font-size: 14px; max-width: 1000px; margin: 0 auto;">
<div style="flex: 1; padding: 15px; background-color: #f5f7f9; border-radius: 8px; margin-right: 10px;">
<h3 style="color: #2c3e50; margin-top: 0; border-bottom: 1px solid #ddd; padding-bottom: 8px;">PII Direct Identifiers</h3>
<p style="font-style: italic; color: #555; margin-bottom: 15px;">Information that identifies a data subject without further context</p>
<ul style="padding-left: 20px; line-height: 1.5; margin-top: 0;">
<li>Names: Full names, first names, last names, nicknames, maiden names, birth names, aliases</li>
<li>Addresses: Street addresses, postal codes, city, state, country</li>
<li>Contact Information: Phone numbers, email addresses</li>
<li>Government IDs: Social Security Numbers (SSNs), passport numbers, driver's license numbers, tax identification numbers</li>
<li>Financial Information: Credit card numbers, bank account numbers, routing numbers</li>
<li>Biometric Data: Fingerprints, retina scans, voice signatures, facial recognition data</li>
<li>Date of Birth of data subject</li>
<li>Place of Birth of data subject</li>
<li>Gender of data subject</li>
<li>Race of data subject</li>
<li>Religion of data subject</li>
</ul>
</div>
<div style="flex: 1; padding: 15px; background-color: #f5f7f9; border-radius: 8px; margin-left: 10px;">
<h3 style="color: #2c3e50; margin-top: 0; border-bottom: 1px solid #ddd; padding-bottom: 8px;">PII Indirect Identifiers</h3>
<p style="font-style: italic; color: #555; margin-bottom: 15px;">Information that can be used to identify a data subject in context or in combination with other information</p>
<ul style="padding-left: 20px; line-height: 1.5; margin-top: 0;">
<li>IP Addresses</li>
<li>Login IDs</li>
<li>Geolocations</li>
<li>Employment Information</li>
<li>Education Information</li>
<li>Medical Information</li>
<li>Usernames</li>
<li>Passwords</li>
<li>Keys</li>
<li>URLs</li>
<li>Company Names</li>
</ul>
</div>
</div>
2025-04-04 16:29:58 +00:00
2025-03-26 18:26:06 +00:00
</header>
<div class="info-bar">
<div class="info-item">
<h3>Generated On</h3>
<p>{current_time}</p>
</div>
<div class="info-item">
<h3>Workspace</h3>
<p title="{workspace_path}">{workspace_path}</p>
</div>
<div class="info-item">
<h3>Sample Size</h3>
<p>{len(random_pages)} pages</p>
</div>
</div>
<div class="page-grid">
"""
2025-03-26 18:26:06 +00:00
for i, (pdf_path, page_num, page_text, result_file) in enumerate(tqdm(random_pages, desc="Rendering pages")):
# Get original URL from PDF hash
pdf_hash = parse_pdf_hash(pdf_path)
original_url = get_original_url(pdf_hash, db_path) if pdf_hash else None
# Create a truncated path for display
display_path = pdf_path
if len(display_path) > 60:
display_path = "..." + display_path[-57:]
2025-03-26 18:26:06 +00:00
# Generate presigned URL
presigned_url = create_presigned_url(pdf_s3_client, pdf_path)
2025-03-26 18:26:06 +00:00
try:
# Download PDF to temp file
bucket, key = parse_s3_path(pdf_path)
with tempfile.NamedTemporaryFile(suffix=".pdf", delete=False) as temp_file:
pdf_data = pdf_s3_client.get_object(Bucket=bucket, Key=key)["Body"].read()
2025-03-26 18:26:06 +00:00
temp_file.write(pdf_data)
temp_file_path = temp_file.name
2025-03-26 18:26:06 +00:00
# Render PDF to base64 webp
base64_image = render_pdf_to_base64webp(temp_file_path, page_num, resolution)
2025-04-04 16:19:04 +00:00
# Add CSS class for the first annotation interface to be active by default
active_class = " active" if i == 0 else ""
# Add to HTML with the annotation interface
html_content += f"""
2025-04-04 16:19:04 +00:00
<div class="page-container" data-index="{i}">
<div class="page-info">
<h2 title="{pdf_path}"><a href="{original_url}" target="_blank">{original_url}</a></h2>
<p>Page {page_num}</p>
<p>{f'<a href="{presigned_url}" target="_blank">View Cached PDF</a>' if presigned_url else pdf_path}</p>
2025-04-04 16:19:04 +00:00
<p>
Status: <span class="annotation-status status-pending" id="status-{i}">Pending</span>
</p>
2025-03-26 18:26:06 +00:00
</div>
<div class="page-image-wrapper">
<img class="page-image" src="data:image/webp;base64,{base64_image}" alt="PDF Page {page_num}" loading="lazy" />
2025-03-26 18:26:06 +00:00
</div>
2025-04-04 19:36:10 +00:00
<div class="annotation-interface{active_class}" data-id="page-{i}" data-pdf-path="{pdf_path}">
2025-04-04 16:19:04 +00:00
<span class="btn-group">
<button type="button" class="toggle-button feedback-option" data-value="yes-pii" onclick="toggleFeedbackOption(this)">Yes PII</button>
<button type="button" class="toggle-button feedback-option" data-value="no-pii" onclick="toggleFeedbackOption(this)">No PII</button>
<button type="button" class="toggle-button feedback-option" data-value="cannot-read" onclick="toggleFeedbackOption(this)">I cannot read this</button>
<button type="button" class="toggle-button feedback-option" data-value="disturbing" onclick="toggleFeedbackOption(this)">Disturbing content</button>
</span>
<textarea placeholder="Describe any private PII in the document" onchange="saveFeedback(this)" onkeydown="handleTextareaKeydown(event, this)"></textarea>
</div>
</div>
"""
2025-03-26 18:26:06 +00:00
# Clean up temp file
os.unlink(temp_file_path)
2025-03-26 18:26:06 +00:00
except Exception as e:
2025-04-04 16:19:04 +00:00
# Add CSS class for the first annotation interface to be active by default
active_class = " active" if i == 0 else ""
2025-04-04 17:18:19 +00:00
2025-03-26 18:26:06 +00:00
html_content += f"""
2025-04-04 16:19:04 +00:00
<div class="page-container" data-index="{i}">
2025-03-26 18:26:06 +00:00
<div class="page-info">
<h2 title="{pdf_path}"><a href="{original_url}" target="_blank">{original_url}</a></h2>
<p>Page {page_num}</p>
<p>{f'<a href="{presigned_url}" target="_blank">View Cached PDF</a>' if presigned_url else pdf_path}</p>
2025-04-04 16:19:04 +00:00
<p>
Status: <span class="annotation-status status-pending" id="status-{i}">Pending</span>
</p>
2025-03-26 18:26:06 +00:00
</div>
<div class="error">Error: {str(e)}</div>
2025-04-04 19:36:10 +00:00
<div class="annotation-interface{active_class}" data-id="page-{i}" data-pdf-path="{pdf_path}">
2025-04-04 16:19:04 +00:00
<span class="btn-group">
<button type="button" class="toggle-button feedback-option" data-value="yes-pii" onclick="toggleFeedbackOption(this)">Yes PII</button>
<button type="button" class="toggle-button feedback-option" data-value="no-pii" onclick="toggleFeedbackOption(this)">No PII</button>
<button type="button" class="toggle-button feedback-option" data-value="cannot-read" onclick="toggleFeedbackOption(this)">I cannot read this</button>
<button type="button" class="toggle-button feedback-option" data-value="disturbing" onclick="toggleFeedbackOption(this)">Disturbing content</button>
</span>
<textarea placeholder="Describe any private PII in the document" onchange="saveFeedback(this)" onkeydown="handleTextareaKeydown(event, this)"></textarea>
</div>
2025-03-26 18:26:06 +00:00
</div>
"""
2025-04-04 17:18:19 +00:00
html_content += (
"""
2025-03-26 18:26:06 +00:00
</div>
2025-04-04 16:19:04 +00:00
<div class="completion-message" id="completion-message">
2025-04-04 17:12:46 +00:00
Thank you! All annotations are complete.<br>
Your Prolific completion code is: <strong id="prolific-code">Loading...</strong>
2025-04-04 16:19:04 +00:00
</div>
2025-04-04 17:12:46 +00:00
<!-- Store the obfuscated code in a hidden element -->
2025-04-04 17:18:19 +00:00
<div id="obfuscated-code" style="display:none;">"""
+ obfuscated_code
+ """</div>
2025-04-04 16:19:04 +00:00
<div class="annotation-progress" id="progress-bar">
<div class="progress-text">
Annotation Progress: <span id="current-page">1</span>/<span id="total-pages"></span>
</div>
<div class="progress-bar">
<div class="progress-fill" id="progress-fill"></div>
</div>
</div>
2025-03-26 18:26:06 +00:00
</div>
2025-04-01 18:35:04 +00:00
<script>
// Using externally injected async functions: fetchDatastore() and putDatastore()
2025-04-04 16:19:04 +00:00
// Track annotation progress
let currentIndex = 0;
const totalPages = document.querySelectorAll('.page-container').length;
document.getElementById('total-pages').textContent = totalPages;
// Update progress bar
function updateProgressBar() {
2025-04-04 17:53:26 +00:00
const progressPercent = ((currentIndex) / totalPages) * 100;
2025-04-04 16:19:04 +00:00
document.getElementById('progress-fill').style.width = progressPercent + '%';
2025-04-04 17:53:26 +00:00
document.getElementById('current-page').textContent = currentIndex;
2025-04-04 16:19:04 +00:00
2025-04-04 17:53:26 +00:00
console.log(totalPages, currentIndex);
2025-04-04 16:19:04 +00:00
// Check if all annotations are complete
2025-04-04 17:53:26 +00:00
if (currentIndex >= totalPages) {
2025-04-04 16:19:04 +00:00
document.getElementById('progress-bar').style.display = 'none';
document.getElementById('completion-message').style.display = 'block';
}
}
// Update status indicators
function updateStatusIndicators() {
// Reset all status indicators
document.querySelectorAll('.annotation-status').forEach(function(status) {
status.className = 'annotation-status status-pending';
status.textContent = 'Pending';
2025-04-04 19:38:59 +00:00
// Remove any click handlers
status.onclick = null;
2025-04-04 16:19:04 +00:00
});
// Set current item status
const currentStatus = document.getElementById(`status-${currentIndex}`);
if (currentStatus) {
currentStatus.className = 'annotation-status status-current';
currentStatus.textContent = 'Current';
}
// Update completed statuses
for (let i = 0; i < currentIndex; i++) {
const status = document.getElementById(`status-${i}`);
if (status) {
status.className = 'annotation-status status-complete';
2025-04-04 19:38:59 +00:00
status.textContent = 'Edit ✎';
// Add click handler to edit this annotation
status.onclick = function() { editAnnotation(i); };
2025-04-04 16:19:04 +00:00
}
}
}
2025-04-04 19:38:59 +00:00
// Function to enable editing a previously completed annotation
function editAnnotation(index) {
// Hide current annotation interface
document.querySelector(`.annotation-interface[data-id="page-${currentIndex}"]`).classList.remove('active');
// Remove editing class from all containers
document.querySelectorAll('.page-container').forEach(container => {
container.classList.remove('editing');
});
// Show the selected annotation interface
document.querySelector(`.annotation-interface[data-id="page-${index}"]`).classList.add('active');
// Add editing class to the container being edited
const activeContainer = document.querySelector(`.page-container[data-index="${index}"]`);
if (activeContainer) {
activeContainer.classList.add('editing');
activeContainer.scrollIntoView({ behavior: 'smooth', block: 'center' });
}
// Update current index
currentIndex = index;
updateProgressBar();
updateStatusIndicators();
}
2025-04-04 16:19:04 +00:00
// Navigate to the next document
function goToNextDocument() {
// Hide current annotation interface
document.querySelector(`.annotation-interface[data-id="page-${currentIndex}"]`).classList.remove('active');
2025-04-04 19:38:59 +00:00
// Remove editing class from all containers
document.querySelectorAll('.page-container').forEach(container => {
container.classList.remove('editing');
});
2025-04-04 16:19:04 +00:00
// Move to next document if not at the end
if (currentIndex < totalPages - 1) {
currentIndex++;
document.querySelector(`.annotation-interface[data-id="page-${currentIndex}"]`).classList.add('active');
2025-04-04 19:38:59 +00:00
// Add editing class to current container
2025-04-04 16:19:04 +00:00
const activeContainer = document.querySelector(`.page-container[data-index="${currentIndex}"]`);
if (activeContainer) {
2025-04-04 19:38:59 +00:00
activeContainer.classList.add('editing');
2025-04-04 16:19:04 +00:00
activeContainer.scrollIntoView({ behavior: 'smooth', block: 'center' });
}
2025-04-04 19:38:59 +00:00
updateProgressBar();
updateStatusIndicators();
2025-04-04 16:19:04 +00:00
}
2025-04-04 17:53:26 +00:00
else {
// This was the last document, mark as complete
currentIndex = totalPages;
updateProgressBar();
updateStatusIndicators();
// Show completion message and scroll to it
document.getElementById('progress-bar').style.display = 'none';
document.getElementById('completion-message').style.display = 'block';
document.getElementById('completion-message').scrollIntoView({ behavior: 'smooth', block: 'center' });
}
2025-04-04 16:19:04 +00:00
}
// Handle text area keydown for Enter key
function handleTextareaKeydown(event, textarea) {
// If Enter key is pressed and not with Shift key, move to next document
if (event.key === 'Enter' && !event.shiftKey) {
event.preventDefault();
saveFeedback(textarea);
goToNextDocument();
}
}
async function saveFeedback(source) {
2025-04-04 16:19:04 +00:00
const interfaceDiv = source.closest('.annotation-interface');
const id = interfaceDiv.getAttribute('data-id');
2025-04-04 16:05:04 +00:00
// Get the selected feedback option value
2025-04-04 16:19:04 +00:00
const activeButton = interfaceDiv.querySelector('button.feedback-option.active');
2025-04-04 16:05:04 +00:00
const feedbackOption = activeButton ? activeButton.getAttribute('data-value') : null;
2025-04-04 16:19:04 +00:00
const piiDescription = interfaceDiv.querySelector('textarea').value;
2025-04-04 19:36:10 +00:00
const pdfPath = interfaceDiv.getAttribute('data-pdf-path');
2025-04-01 18:35:04 +00:00
const datastore = await fetchDatastore() || {};
datastore[id] = {
2025-04-04 16:05:04 +00:00
feedbackOption: feedbackOption,
2025-04-04 19:36:10 +00:00
piiDescription: piiDescription,
pdfPath: pdfPath
2025-04-01 18:35:04 +00:00
};
await putDatastore(datastore);
}
2025-04-04 16:05:04 +00:00
function toggleFeedbackOption(btn) {
2025-04-04 16:19:04 +00:00
const interfaceDiv = btn.closest('.annotation-interface');
2025-04-04 16:05:04 +00:00
// Remove active class from all feedback option buttons in this group
2025-04-04 16:19:04 +00:00
interfaceDiv.querySelectorAll('button.feedback-option').forEach(function(b) {
b.classList.remove('active');
});
// Toggle on the clicked button
btn.classList.add('active');
2025-04-04 16:19:04 +00:00
saveFeedback(interfaceDiv);
// Show or hide textarea based on selected option
const textarea = interfaceDiv.querySelector('textarea');
const feedbackOption = btn.getAttribute('data-value');
if (feedbackOption === 'yes-pii') {
// Only show textarea if "Yes PII" is selected
textarea.style.display = 'block';
textarea.focus();
} else {
// If other options selected, hide textarea and go to next
textarea.style.display = 'none';
goToNextDocument();
}
}
2025-04-04 17:12:46 +00:00
// Function to deobfuscate the Prolific code
function deobfuscateCode(obfuscatedCode) {
// Reverse the string
const reversed = obfuscatedCode.split('').reverse().join('');
// Decode from base64
try {
return atob(reversed);
} catch (e) {
return "ERROR_DECODING";
}
}
2025-04-01 18:35:04 +00:00
document.addEventListener("DOMContentLoaded", async function() {
const datastore = await fetchDatastore() || {};
2025-04-04 19:38:59 +00:00
// Add editing class to the first container by default
const firstContainer = document.querySelector(`.page-container[data-index="0"]`);
if (firstContainer) {
firstContainer.classList.add('editing');
}
2025-04-04 16:19:04 +00:00
updateProgressBar();
updateStatusIndicators();
2025-04-04 17:12:46 +00:00
// Get and deobfuscate the Prolific code
const obfuscatedCode = document.getElementById('obfuscated-code').textContent;
const prolificCode = deobfuscateCode(obfuscatedCode);
document.getElementById('prolific-code').textContent = prolificCode;
2025-04-04 16:19:04 +00:00
document.querySelectorAll('.annotation-interface').forEach(function(interfaceDiv) {
const id = interfaceDiv.getAttribute('data-id');
2025-04-01 18:35:04 +00:00
if (datastore[id]) {
const data = datastore[id];
2025-04-04 16:05:04 +00:00
// Set active state for feedback option buttons
2025-04-04 16:19:04 +00:00
interfaceDiv.querySelectorAll('button.feedback-option').forEach(function(btn) {
2025-04-04 16:05:04 +00:00
if (btn.getAttribute('data-value') === data.feedbackOption) {
btn.classList.add('active');
2025-04-04 16:19:04 +00:00
// Show textarea if "Yes PII" is selected
if (btn.getAttribute('data-value') === 'yes-pii') {
interfaceDiv.querySelector('textarea').style.display = 'block';
}
} else {
btn.classList.remove('active');
}
});
// Set the textarea value
2025-04-04 16:19:04 +00:00
interfaceDiv.querySelector('textarea').value = data.piiDescription;
2025-04-01 18:35:04 +00:00
}
});
2025-04-04 16:19:04 +00:00
// If we have stored data, restore the current position
let lastAnnotatedIndex = -1;
for (let i = 0; i < totalPages; i++) {
const pageId = `page-${i}`;
if (datastore[pageId] && datastore[pageId].feedbackOption) {
lastAnnotatedIndex = i;
}
}
// If we have annotated pages, go to the first unannotated page
if (lastAnnotatedIndex >= 0 && lastAnnotatedIndex < totalPages - 1) {
document.querySelector(`.annotation-interface.active`).classList.remove('active');
currentIndex = lastAnnotatedIndex + 1;
document.querySelector(`.annotation-interface[data-id="page-${currentIndex}"]`).classList.add('active');
2025-04-04 19:38:59 +00:00
// Add editing class and scroll to the active annotation
2025-04-04 16:19:04 +00:00
const activeContainer = document.querySelector(`.page-container[data-index="${currentIndex}"]`);
if (activeContainer) {
2025-04-04 19:38:59 +00:00
// Remove editing class from all containers first
document.querySelectorAll('.page-container').forEach(container => {
container.classList.remove('editing');
});
// Add editing class to current container
activeContainer.classList.add('editing');
2025-04-04 16:19:04 +00:00
activeContainer.scrollIntoView({ behavior: 'smooth', block: 'center' });
}
updateProgressBar();
updateStatusIndicators();
}
2025-04-01 18:35:04 +00:00
});
</script>
2025-03-26 18:26:06 +00:00
</body>
</html>
"""
2025-04-04 17:18:19 +00:00
)
with open(output_path, "w") as f:
2025-03-26 18:26:06 +00:00
f.write(html_content)
2025-03-26 18:26:06 +00:00
print(f"Created HTML output at {output_path}")
2025-03-26 18:26:06 +00:00
def generate_sample_set(args, i, s3_client, pdf_s3_client, result_files):
"""Generate a single sample set."""
output_filename = Path(args.output_dir) / f"dolma_samples_{i+1}.html"
2025-03-26 18:26:06 +00:00
print(f"\nGenerating sample set {i+1} of {args.repeats}")
2025-03-26 18:26:06 +00:00
# Get random pages
random_pages = get_random_pages(s3_client, result_files, args.pages_per_output)
2025-04-04 17:12:46 +00:00
# Generate a unique Prolific code for this sample set
prolific_code = generate_prolific_code()
2025-04-04 17:18:19 +00:00
2025-04-04 17:12:46 +00:00
# Create HTML output with the Prolific code
create_html_output(random_pages, pdf_s3_client, output_filename, args.workspace, args.db_path, prolific_code)
2025-04-04 17:12:46 +00:00
return output_filename, prolific_code
2025-03-26 18:26:06 +00:00
2025-04-04 19:44:54 +00:00
def extract_datastore_url(html_content: str) -> Optional[str]:
"""Extract the presigned datastore URL from HTML content."""
match = re.search(r'const\s+presignedGetUrl\s*=\s*"([^"]+)"', html_content)
if match:
return match.group(1)
return None
def fetch_annotations(tinyhost_link: str) -> Tuple[Dict[str, Any], str]:
"""Fetch and parse annotations from a tinyhost link."""
# Request the HTML content
print(f"Fetching annotations from {tinyhost_link}")
response = requests.get(tinyhost_link)
response.raise_for_status()
html_content = response.text
# Extract the datastore URL
datastore_url = extract_datastore_url(html_content)
if not datastore_url:
print(f"Could not find datastore URL in {tinyhost_link}")
return {}, tinyhost_link
# Fetch the datastore content
print(f"Found datastore URL: {datastore_url}")
try:
datastore_response = requests.get(datastore_url)
datastore_response.raise_for_status()
annotations = datastore_response.json()
return annotations, tinyhost_link
except Exception as e:
print(f"Error fetching datastore from {datastore_url}: {e}")
return {}, tinyhost_link
def process_annotations(annotations_by_link: List[Tuple[Dict[str, Any], str]]) -> Dict[str, List[Dict[str, Any]]]:
"""Process and categorize annotations by feedback type."""
results = {
"yes_pii": [],
"no_pii": [],
"cannot_read": [],
"disturbing": [],
"no_annotation": [],
}
# Process each annotation
for annotations, link in annotations_by_link:
for page_id, annotation in annotations.items():
if not annotation or "feedbackOption" not in annotation:
results["no_annotation"].append(
{"page_id": page_id, "link": link, "pdf_path": annotation.get("pdfPath", "Unknown") if annotation else "Unknown"}
)
continue
category = annotation["feedbackOption"]
result_item = {
"page_id": page_id,
"link": link,
"pdf_path": annotation.get("pdfPath", "Unknown"),
"description": annotation.get("piiDescription", ""),
}
if category == "yes-pii":
results["yes_pii"].append(result_item)
elif category == "no-pii":
results["no_pii"].append(result_item)
elif category == "cannot-read":
results["cannot_read"].append(result_item)
elif category == "disturbing":
results["disturbing"].append(result_item)
else:
results["no_annotation"].append(result_item)
return results
def print_annotation_report(annotation_results: Dict[str, List[Dict[str, Any]]]):
"""Print a summary report of annotations."""
total_pages = sum(len(items) for items in annotation_results.values())
print("\n" + "=" * 80)
print(f"ANNOTATION REPORT - Total Pages: {total_pages}")
print("=" * 80)
# Print summary statistics
print("\nSummary:")
print(f" Pages with PII: {len(annotation_results['yes_pii'])} ({len(annotation_results['yes_pii'])/total_pages*100:.1f}%)")
print(f" Pages without PII: {len(annotation_results['no_pii'])} ({len(annotation_results['no_pii'])/total_pages*100:.1f}%)")
print(f" Unreadable pages: {len(annotation_results['cannot_read'])} ({len(annotation_results['cannot_read'])/total_pages*100:.1f}%)")
print(f" Pages with disturbing content: {len(annotation_results['disturbing'])} ({len(annotation_results['disturbing'])/total_pages*100:.1f}%)")
print(f" Pages without annotation: {len(annotation_results['no_annotation'])} ({len(annotation_results['no_annotation'])/total_pages*100:.1f}%)")
# Print detailed report for pages with PII
if annotation_results["yes_pii"]:
print("\nDetailed Report - Pages with PII:")
print("-" * 80)
for i, item in enumerate(annotation_results["yes_pii"], 1):
print(f"{i}. PDF: {item['pdf_path']}")
print(f" Page ID: {item['page_id']}")
print(f" Link: {item['link']}#{item['page_id']}")
print(f" Description: {item['description']}")
print("-" * 80)
print("\nReport complete.")
def read_and_process_results(args):
"""Read and process results from a previously generated CSV file."""
try:
# Read the CSV file
links = []
with open(args.read_results, "r") as f:
reader = csv.DictReader(f)
for row in reader:
if "tinyhost_link" in row:
links.append(row["tinyhost_link"])
if not links:
print(f"No tinyhost links found in {args.read_results}")
return
print(f"Found {len(links)} tinyhost links in {args.read_results}")
# Fetch and process annotations
annotations_by_link = []
for link in tqdm(links, desc="Fetching annotations"):
try:
annotations, link_url = fetch_annotations(link)
annotations_by_link.append((annotations, link_url))
except Exception as e:
print(f"Error processing {link}: {e}")
# Process and categorize annotations
annotation_results = process_annotations(annotations_by_link)
# Print report
print_annotation_report(annotation_results)
# Save detailed report to file
output_file = Path(args.output_dir) / "annotation_report.csv"
print(f"\nSaving detailed report to {output_file}")
with open(output_file, "w", newline="") as f:
writer = csv.writer(f)
writer.writerow(["Category", "PDF Path", "Page ID", "Link", "Description"])
for category, items in annotation_results.items():
for item in items:
writer.writerow([category, item["pdf_path"], item["page_id"], f"{item['link']}#{item['page_id']}", item.get("description", "")])
print(f"Report saved to {output_file}")
except Exception as e:
print(f"Error processing results: {e}")
2025-03-26 18:26:06 +00:00
def main():
args = parse_args()
2025-04-04 19:44:54 +00:00
# Check if we're reading results from a previous run
if args.read_results:
read_and_process_results(args)
return
2025-03-26 18:26:06 +00:00
# Set up S3 clients
s3_client = boto3.client("s3")
2025-03-26 18:26:06 +00:00
# Set up PDF S3 client with profile if specified
if args.pdf_profile:
pdf_session = boto3.Session(profile_name=args.pdf_profile)
pdf_s3_client = pdf_session.client("s3")
else:
pdf_s3_client = s3_client
2025-03-26 18:26:06 +00:00
# Create output directory
output_dir = Path(args.output_dir)
output_dir.mkdir(exist_ok=True, parents=True)
2025-03-26 18:26:06 +00:00
# List all result files
print(f"Listing result files in {args.workspace}/results...")
result_files = list_result_files(s3_client, args.workspace)
print(f"Found {len(result_files)} result files")
2025-03-26 18:26:06 +00:00
# Use ThreadPoolExecutor to parallelize the generation of sample sets
2025-04-04 16:29:58 +00:00
output_files = []
2025-04-04 17:12:46 +00:00
prolific_codes = []
2025-04-04 16:29:58 +00:00
2025-03-26 18:26:06 +00:00
if args.repeats > 1:
print(f"Using ThreadPoolExecutor with {min(args.max_workers, args.repeats)} workers")
with ThreadPoolExecutor(max_workers=min(args.max_workers, args.repeats)) as executor:
futures = []
for i in range(args.repeats):
future = executor.submit(generate_sample_set, args, i, s3_client, pdf_s3_client, result_files)
2025-03-26 18:26:06 +00:00
futures.append(future)
2025-03-26 18:26:06 +00:00
# Wait for all futures to complete and collect results
for future in futures:
try:
2025-04-04 17:12:46 +00:00
output_filename, prolific_code = future.result()
2025-04-04 16:29:58 +00:00
output_files.append(output_filename)
2025-04-04 17:12:46 +00:00
prolific_codes.append(prolific_code)
print(f"Completed generation of {output_filename} with code {prolific_code}")
2025-03-26 18:26:06 +00:00
except Exception as e:
print(f"Error generating sample set: {e}")
else:
# If only one repeat, just run it directly
2025-04-04 17:12:46 +00:00
output_filename, prolific_code = generate_sample_set(args, 0, s3_client, pdf_s3_client, result_files)
2025-04-04 16:29:58 +00:00
output_files.append(output_filename)
2025-04-04 17:12:46 +00:00
prolific_codes.append(prolific_code)
2025-04-04 16:29:58 +00:00
# Now upload each resulting file into tinyhost
print("Generated all files, uploading tinyhost links now")
links = []
for output_filename in output_files:
2025-04-04 17:18:41 +00:00
link = tinyhost.tinyhost([str(output_filename)])[0]
links.append(link)
2025-04-04 16:29:58 +00:00
print(link)
2025-04-04 17:18:19 +00:00
2025-04-04 17:12:46 +00:00
# Create CSV file with tinyhost links and Prolific codes
csv_path = args.prolific_csv
print(f"Writing Prolific codes to {csv_path}")
2025-04-04 17:18:19 +00:00
with open(csv_path, "w", newline="") as csvfile:
2025-04-04 17:12:46 +00:00
writer = csv.writer(csvfile)
2025-04-04 17:18:19 +00:00
writer.writerow(["tinyhost_link", "code"])
2025-04-04 17:12:46 +00:00
for link, code in zip(links, prolific_codes):
writer.writerow([link, code])
2025-04-04 17:18:19 +00:00
2025-04-04 17:12:46 +00:00
print(f"Prolific codes written to {csv_path}")
2025-03-26 18:26:06 +00:00
2025-03-26 18:26:06 +00:00
if __name__ == "__main__":
2025-04-04 17:18:19 +00:00
main()