Skip to content

Fix remaining broken pretrain_distill docs links - #940

Merged
liopeer merged 2 commits into
lightly-ai:mainfrom
minutechreview:fix/remaining-pretrain-distill-links
Aug 12, 2026
Merged

Fix remaining broken pretrain_distill docs links#940
liopeer merged 2 commits into
lightly-ai:mainfrom
minutechreview:fix/remaining-pretrain-distill-links

Conversation

@minutechreview

Copy link
Copy Markdown
Contributor

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:

file before after
src/lightly_train/_cli.py:57 pretrain_distill.html pretrain_distill/index.html
src/lightly_train/_commands/train.py:88 pretrain_distill.html pretrain_distill/index.html
examples/notebooks/distillation.ipynb:384 pretrain_distill.html pretrain_distill/index.html
examples/notebooks/distillation.ipynb:90 pretrain_distill.html#train-data pretrain_distill/index.html#pretrain-data

The fourth one

In #934 I flagged the notebook's data-guide link as needing a decision, because its #train-data anchor doesn't exist. I've since found the intended target: the Data section in docs/source/pretrain_distill/index.md is anchored (pretrain-data)= (line 120), not train-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.html404; pretrain_distill/index.html200
  • id="pretrain-data" is present on the rendered page; id="train-data" is not
  • pretrain_distill/index.html is already the form used elsewhere in these same files (e.g. the #resume-training links at _cli.py:119/133), so this is consistent rather than a new convention
  • distillation.ipynb still parses as valid JSON (21 cells)
  • _cli.py and _commands/train.py both compile

After this, grep -rn "pretrain_distill\.html" returns nothing across the repo.

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.
@mrpositron

Copy link
Copy Markdown
Contributor

/review

@liopeer liopeer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

@liopeer
liopeer enabled auto-merge (squash) August 12, 2026 14:42
@liopeer
liopeer merged commit 8b19c68 into lightly-ai:main Aug 12, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants