Merged
Conversation
Contributor
Author
|
/review |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the LightlyTrain training settings documentation to better explain how metric_args controls metric computation/logging, with a focus on image-classification examples and discoverability via train.log.
Changes:
- Adds an example of the default (classification)
metric_argsconfiguration as shown intrain.log, plus guidance on customizing it. - Adds examples for configuring
accuracy.topkand disabling a metric by setting it toNone. - Moves/expands the
trainsubsection and clarifies references totrain.logfor available metrics.
yutong-xiang-97
approved these changes
Mar 24, 2026
added 2 commits
March 24, 2026 09:57
…d' of https://github.com/lightly-ai/lightly-train into guarin-trn-1841-document-metric_args-in-train_settingsmd
guarin
deleted the
guarin-trn-1841-document-metric_args-in-train_settingsmd
branch
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.
What has changed and why?
How has it been tested?
Did you update CHANGELOG.md?
Did you update the documentation?