Skip to content

docs: update README with benchmarks, OCR guidelines, and Firecrawl attributions; remove unused .githooks - #35

Merged
sanjeevafk merged 1 commit into
mainfrom
docs/update-readme-and-remove-githooks
Oct 5, 2026
Merged

sanjeevafk merged 1 commit into
mainfrom
docs/update-readme-and-remove-githooks

Conversation

@sanjeevafk

Copy link
Copy Markdown
Owner

Summary

This PR follows up on #34 with documentation additions and workspace hygiene:

  1. Empirical Benchmark Results in README:

    • Added empirical evaluation results for CS Research Papers (100% Hit@5, 0.8200 MRR) and Biographies & Memoirs (70% Hit@5, 0.6200 MRR, 100% Hit@1 on clean digital texts).
  2. Document Ingestion & OCR Guidelines:

    • Documented the two-tier AnyDoc native parser + pdf-inspector fallback architecture.
    • Clarified why OCR / VLMs are intentionally decoupled from the core Docker image (avoiding 5+ GB container bloat and CPU stalls).
    • Recommends using Tesseract for CPU-only environments or any model of choice (e.g. via ocrmypdf) before ingestion.
  3. Attributions:

  4. Repository Cleanup:

    • Deleted unused .githooks/post-commit and scripts/refresh_code_review_graph.sh, eliminating unnecessary code-review-graph warnings on commits.

…tributions; remove unused .githooks

- Add empirical benchmark accuracy table for research papers and biography datasets
- Document OCR/VLM pre-processing recommendations for scanned and garbled PDFs
- Attribute AnyDoc and PDF-Inspector to Firecrawl
- Remove unused .githooks and refresh_code_review_graph.sh
@sanjeevafk
sanjeevafk merged commit 7350c9e into main Oct 5, 2026
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant