[hallelx2]

Every tag up to v0.4.0 declares the old module path, so go get @vx fails (HAL-2690). Until a new tag exists, the README now installs from @main. Adds a version table and reports the per-document ICDAR 2013 F1 (0.442 vs pdfplumber's 0.458) the competition uses.

Verified on Lorx CI (GitHub Actions can't start jobs on this account, HAL-1712).

Closes HAL-2713

Summary by Sourcery

Make the README and project documentation accurately reflect the renamed module, current install path, release state, and evaluation metrics.

Bug Fixes:

• Correct the documented ICDAR 2013 evaluation to report the competition’s per-document F1 score of 0.442 alongside the pooled metric.

Enhancements:

• Document the project’s module rename, available versions, benchmark results, limitations, and current maintenance status.

Documentation:

• Update installation instructions to use the renamed module from main until a compatible release tag is available.
• Add version history and benchmark tables, clarify tagged versus untagged releases, and revise roadmap and evaluation documentation.

Summary by CodeRabbit

• New Features

  • Added optional text-edge region detection for identifying table areas.

• Documentation

  • Updated installation guidance for the move from github.com/hallelx2/pdftable to github.com/hallelx2/pdfgrab. Until a release is tagged under the new module path, use @main.
  • Clarified benchmark reporting by distinguishing pooled and per-document F1 scores, including updated ICDAR results.
  • Updated project status, CLI guidance, release history, and table strategy documentation.

[sourcery-ai]

Sorry @hallelx2, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 1 day and 10 hours by commenting @sourcery-ai review. Upgrade to get a review now.

[sourcery-ai]

Reviewer's Guide

The PR updates project documentation to make installation from the renamed module reliable via @main, accurately distinguish tagged and untagged versions, correct ICDAR reporting to the competition’s per-document F1, and transparently document benchmark limitations, project status, and unfinished roadmap work.

Flow diagram for reliable module installation

flowchart LR
    User[Developer] --> Install[go get github.com/hallelx2/pdfgrab@main]
    Install --> Main[main branch]
    OldTag[v0.4.0 tag] --> OldPath[github.com/hallelx2/pdftable]
    Install -. avoids module path mismatch .-> OldTag

Loading

Flow diagram for corrected ICDAR F1 reporting

flowchart LR
    Corpus[ICDAR 2013 corpus] --> Harness[Evaluation harness]
    Harness --> PerDoc[Per-document F1]
    Harness --> Pooled[Pooled F1]
    PerDoc --> Result[pdfgrab 0.442]
    PerDoc --> Comparison[pdfplumber 0.458]
    Pooled --> Legacy[Older reports: 0.362]

Loading

File-Level Changes

Change	Details	Files
Document the module-path transition and provide an installation path that works before the next release tag.	Update README install commands to use @main for the library and CLI. Add a checked version table distinguishing main, the untagged 0.5.0 entry, and the latest v0.4.0 tag. Explain the old module path retained by existing tags and compatibility with Vectorless. Record the module rename and tagging caveat in the unreleased changelog.	README.md CHANGELOG.md
Correct the published ICDAR 2013 evaluation metric and make benchmark claims explicit about their measurement regime.	Report per-document F1 of 0.442 for pdfgrab versus 0.458 for pdfplumber, alongside the pooled 0.362 figure. Add benchmark context for corpus size, ranking, speed, oracle-grid accuracy, and word-position fidelity. Clarify that pooled, per-document, oracle-boundary, and agreement-with-pdfplumber figures are not interchangeable. Annotate historical evaluation entries with the corrected metric interpretation.	README.md CHANGELOG.md docs/README.md
Reframe the project status and historical roadmap around the current maintenance state and completed experimental work.	State that the hosted Vectorless service is closing and the project is no longer actively developed. Summarize the module rename, metric correction, and opt-in text-edge region detection as post-0.5.0 work. Move planned table-detection and performance work into a clearly identified, unlikely-to-be-completed section with links to negative-result reports.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 08a8001f-7496-4612-81c9-764f9d74faaa

---

📥 Commits

Reviewing files that changed from the base of the PR and between 7dccac2 and 48ac6e1.

---

📒 Files selected for processing (3)

• CHANGELOG.md
• README.md
• docs/README.md

---

 ____________________________________________
< Like a moth to a flame, I'm drawn to bugs. >
 --------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

---

_{Comment @coderabbitai help to get the list of available commands.}