Skip to content

Conversation

yutong-xiang-97
Copy link
Contributor

What has changed and why?

Add links to the Method / Distillation docs page where necessary, including:

  • In the tutorial where we suggest users to explore more methods than distillation
  • Callouts where recommendations to distillation is mentioned

How has it been tested?

Classification with Torchvision’s ResNet - LightlyTrain documentation.pdf
Object Detection with Ultralytics’ YOLO - LightlyTrain documentation.pdf
Quick Start - LightlyTrain documentation.pdf
Train - LightlyTrain documentation.pdf

Did you update CHANGELOG.md?

  • Yes
  • Not needed (internal change)

@Copilot Copilot AI review requested due to automatic review settings April 14, 2025 13:10
Copy link

linear bot commented Apr 14, 2025

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (3)

docs/source/tutorials/yolo/index.md:175

  • The link anchor '#methods' is inconsistent with the new anchor '(methods-comparison)=' introduced in docs/source/methods/index.md. Please update the anchor to '#methods-comparison' for consistency.
+ Go beyond the default distillation pretraining and experiment other pretraining learning methods in LightlyTrain. Check [Methods](#methods) for more information.

docs/source/tutorials/resnet/index.md:347

  • The link anchor '#methods' is inconsistent with the expected '#methods-comparison' anchor. Update the link to ensure users are directed to the correct section.
+ Go beyond the default distillation pretraining and experiment with other pretraining methods in LightlyTrain. Check [Methods](#methods) for more information.

docs/source/methods/index.md:13

  • [nitpick] Consider providing a descriptive heading alongside the '(methods-comparison)=' anchor to clearly indicate the content of this section.
+(methods-comparison)=

Copy link
Contributor

@JonasWurst JonasWurst left a comment

Choose a reason for hiding this comment

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

LGTM

@yutong-xiang-97 yutong-xiang-97 merged commit 64c8405 into main Apr 15, 2025
13 checks passed
@yutong-xiang-97 yutong-xiang-97 deleted the yutong-trn-223-add-link-to-the-distillation-in-docs-tutorials branch April 15, 2025 06:34
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.

2 participants