Skip to content

Add Docs for Multi-channel Image Support#356

Merged
yutong-xiang-97 merged 3 commits intomainfrom
yutong-trn-1560-add-docs-for-multi-channel-image
Oct 16, 2025
Merged

Add Docs for Multi-channel Image Support#356
yutong-xiang-97 merged 3 commits intomainfrom
yutong-trn-1560-add-docs-for-multi-channel-image

Conversation

@yutong-xiang-97
Copy link
Copy Markdown
Contributor

What has changed and why?

Add docs to reflect the changes in #263 and #279

How has it been tested?

Semantic Segmentation - LightlyTrain documentation.pdf
Train - LightlyTrain documentation.pdf

Did you update CHANGELOG.md?

  • Yes
  • Not needed (internal change)

Did you update the documentation?

  • Yes
  • Not needed (internal change without effects for user)

Copilot AI review requested due to automatic review settings October 14, 2025 15:37
Copy link
Copy Markdown
Contributor

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.

Pull Request Overview

This PR adds documentation for multi-channel image support functionality that was previously implemented in PRs #263 and #279. The documentation explains how to configure LightlyTrain to work with 4-channel images instead of the default RGB format.

  • Added comprehensive multi-channel image support documentation with configuration examples
  • Added cross-reference anchor for channel drop augmentation
  • Updated section heading for better clarity

Reviewed Changes

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

File Description
docs/source/train/method_transform_args.md Added cross-reference anchor for channel drop section
docs/source/train/index.md Added detailed multi-channel image support documentation with configuration examples and supported models table
docs/source/semantic_segmentation.md Added multi-channel image support section and fixed section heading

Copy link
Copy Markdown
Contributor

@stegmuel stegmuel left a comment

Choose a reason for hiding this comment

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

Left some suggestions.

yutong-xiang-97 and others added 2 commits October 15, 2025 15:45
Co-authored-by: stegmuel <36367013+stegmuel@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@stegmuel stegmuel 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 3939c08 into main Oct 16, 2025
16 checks passed
@yutong-xiang-97 yutong-xiang-97 deleted the yutong-trn-1560-add-docs-for-multi-channel-image branch October 16, 2025 09:15
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