docs: fix broken relative links in distillation and model list docs#18105
Open
evanclan wants to merge 1 commit into
Open
docs: fix broken relative links in distillation and model list docs#18105evanclan wants to merge 1 commit into
evanclan wants to merge 1 commit into
Conversation
The knowledge-distillation pages linked distillation_model.py with only ../../ (resolving under docs/version2.x/ppocr/) while the same doc's later reference already used ../../../../. Align the early link with the working path. model_list.md row for ch_ppocr_mobile_v2.0_cls used one extra ../ so cls_mv3.yml resolved outside the repo; match the slim row.
|
|
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.
Summary
Fixes three relative markdown links that fail the repo link checker (reported in #18103). Each file already had a correct sibling link for the same target; this PR aligns the broken references with those paths.
Problem
From
docs/version2.x/ppocr/model_compress/knowledge_distillation.{md,en.md}, the firstdistillation_model.pylink used../../ppocr/..., which resolves todocs/version2.x/ppocr/modeling/...(non-existent). The same pages link the file correctly later with../../../../ppocr/modeling/architectures/distillation_model.py.In
docs/version2.x/ppocr/model_list.md, thech_ppocr_mobile_v2.0_clsconfig link used../../../../configs/cls/cls_mv3.yml(one../too many, resolving outside the repo). The slim variant on the preceding row already uses../../../configs/cls/cls_mv3.yml.Solution
knowledge_distillation.md/.en.md: change the earlydistillation_model.pylink to../../../../ppocr/modeling/architectures/distillation_model.py.model_list.md: change thech_ppocr_mobile_v2.0_clsconfig link to../../../configs/cls/cls_mv3.yml.Out of scope
../../../../configs/...links undermodel_train/subdirs — those paths are depth-correct for their directory.Test plan
realpathfrom each doc directory confirms all three links resolve toppocr/modeling/architectures/distillation_model.pyandconfigs/cls/cls_mv3.yml.Related
Made with Cursor