Skip to content

Docs: General documentation updates / fixes#2080

Merged
felixdittrich92 merged 12 commits into
mainfrom
copilot/improvement-check-rework-docs-docstrings
Jun 23, 2026
Merged

Docs: General documentation updates / fixes#2080
felixdittrich92 merged 12 commits into
mainfrom
copilot/improvement-check-rework-docs-docstrings

Conversation

Copilot AI commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

The docs included a standalone section for loading a custom layout model as the default layout_predictor, which duplicated/overlapped guidance and created confusion in the custom-model workflow. This PR removes that redundant block and keeps the OCR pipeline integration path as the canonical example.

  • What changed

    • Removed the section “Load a custom layout analysis model trained on another set of classes as the default one” from:
      • docs/source/using_doctr/custom_models_training.rst
    • Kept the existing OCR integration example (ocr_predictor(..., detect_layout=True, layout_arch=layout_model)) and surrounding custom-model sections intact.
  • Resulting documentation flow

    • Recognition customization example
    • Layout customization through OCR pipeline (single recommended path)
    • KIE/custom preprocessor examples
layout_model = lw_detr_s(pretrained=False, class_names=["heading", "paragraph", "figure", "table"])
layout_model.from_pretrained("<path_to_pt>")

predictor = ocr_predictor(pretrained=True, detect_layout=True, layout_arch=layout_model)

Copilot AI changed the title [WIP] Improve documentation and docstrings Fix inconsistent and outdated docstring formatting across model files Jun 22, 2026
Copilot AI changed the title Fix inconsistent and outdated docstring formatting across model files Fix docstring formatting and improve documentation quality Jun 22, 2026
Copilot AI changed the title Fix docstring formatting and improve documentation quality docs: improve documentation coverage and user experience Jun 22, 2026
Copilot AI changed the title docs: improve documentation coverage and user experience Trim KIE from user docs and tighten related doc references/docstrings Jun 22, 2026
Copilot AI changed the title Trim KIE from user docs and tighten related doc references/docstrings docs: improve user-friendliness across quickstart and model docs Jun 22, 2026
Copilot AI changed the title Tighten documentation quality: restore KIE training snippet and fix docstring rendering in visualization docs: apply PR #2075 docs changes, fix em-dashes and HF Hub wording Jun 23, 2026
Copilot AI requested a review from felixdittrich92 June 23, 2026 07:23
Comment thread docs/source/using_doctr/custom_models_training.rst Outdated
Copilot AI changed the title docs: apply PR #2075 docs changes, fix em-dashes and HF Hub wording docs: remove redundant standalone layout default-model loading snippet Jun 23, 2026
Copilot AI requested a review from felixdittrich92 June 23, 2026 07:32
@felixdittrich92 felixdittrich92 added this to the 1.1.0 milestone Jun 23, 2026
@felixdittrich92 felixdittrich92 added topic: documentation Improvements or additions to documentation ext: docs Related to docs folder labels Jun 23, 2026
Copilot AI changed the title docs: remove redundant standalone layout default-model loading snippet Docs: remove redundant custom layout default-model snippet Jun 23, 2026
Copilot AI requested a review from felixdittrich92 June 23, 2026 07:56
@felixdittrich92 felixdittrich92 changed the title Docs: remove redundant custom layout default-model snippet Docs: General documentation updates / fixes Jun 23, 2026
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.94%. Comparing base (3d5ca38) to head (b5d0262).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2080      +/-   ##
==========================================
+ Coverage   96.89%   96.94%   +0.05%     
==========================================
  Files         156      156              
  Lines        7535     7535              
==========================================
+ Hits         7301     7305       +4     
+ Misses        234      230       -4     
Flag Coverage Δ
unittests 96.94% <100.00%> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@felixdittrich92 felixdittrich92 merged commit c9148f7 into main Jun 23, 2026
52 checks passed
@felixdittrich92 felixdittrich92 deleted the copilot/improvement-check-rework-docs-docstrings branch June 23, 2026 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ext: docs Related to docs folder topic: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants