Fix remaining broken pretrain_distill docs links - #940
Merged
liopeer merged 2 commits intoAug 12, 2026
Merged
Conversation
Follow-up to lightly-ai#934, which fixed the two occurrences in the README and the docs landing page. The same dead base URL remained in the CLI help text, the pretrain() docstring and the distillation notebook: pretrain_distill is a docs directory, so pretrain_distill.html 404s and the correct path is pretrain_distill/index.html — the form already used elsewhere in these same files (e.g. _cli.py's #resume-training links). The notebook's data-guide link also pointed at a #train-data anchor that does not exist. The Data section is anchored (pretrain-data)= in docs/source/pretrain_distill/index.md, so that link now targets #pretrain-data.
Contributor
|
/review |
liopeer
enabled auto-merge (squash)
August 12, 2026 14:42
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.
Follow-up to #934, picking up the instances I listed there but deliberately left out of that PR.
#934 fixed the two occurrences the issue named (README + docs landing page). The same dead base URL was still present in three more places, all now 404:
src/lightly_train/_cli.py:57pretrain_distill.htmlpretrain_distill/index.htmlsrc/lightly_train/_commands/train.py:88pretrain_distill.htmlpretrain_distill/index.htmlexamples/notebooks/distillation.ipynb:384pretrain_distill.htmlpretrain_distill/index.htmlexamples/notebooks/distillation.ipynb:90pretrain_distill.html#train-datapretrain_distill/index.html#pretrain-dataThe fourth one
In #934 I flagged the notebook's data-guide link as needing a decision, because its
#train-dataanchor doesn't exist. I've since found the intended target: the Data section indocs/source/pretrain_distill/index.mdis anchored(pretrain-data)=(line 120), nottrain-data. So that link now points at#pretrain-data.If that isn't the section you meant it to reach, say so and I'll change it — but it's the only Data anchor in that page.
Verification
pretrain_distill.html→ 404;pretrain_distill/index.html→ 200id="pretrain-data"is present on the rendered page;id="train-data"is notpretrain_distill/index.htmlis already the form used elsewhere in these same files (e.g. the#resume-traininglinks at_cli.py:119/133), so this is consistent rather than a new conventiondistillation.ipynbstill parses as valid JSON (21 cells)_cli.pyand_commands/train.pyboth compileAfter this,
grep -rn "pretrain_distill\.html"returns nothing across the repo.