Docs: General documentation updates / fixes#2080
Merged
felixdittrich92 merged 12 commits intoJun 23, 2026
Merged
Conversation
…andardize pretrained descriptions
Copilot
AI
changed the title
[WIP] Improve documentation and docstrings
Fix inconsistent and outdated docstring formatting across model files
Jun 22, 2026
… incorrect kie_predictor example
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
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
felixdittrich92
approved these changes
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
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
felixdittrich92
approved these changes
Jun 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
docs/source/using_doctr/custom_models_training.rstocr_predictor(..., detect_layout=True, layout_arch=layout_model)) and surrounding custom-model sections intact.Resulting documentation flow