Skip to content

Conversation

@relic-yuexi
Copy link

@relic-yuexi relic-yuexi commented Jan 25, 2026

What does this PR do?

This PR adds a new SwanLabLogger to PyTorch Lightning, providing integration with SwanLab (https://swanlab.cn) for enhanced experiment tracking and logging capabilities.

Key Features:

  • Metrics Logging: Automatically log training/validation/test metrics during training
  • Hyperparameter Tracking: Save model hyperparameters and configuration
  • Media Logging Support: Log images, text, audio, and video files
  • Model Checkpoint Logging: Optional automatic logging of model checkpoints
  • Flexible Modes: Support for cloud, local, offline, and disabled modes
  • Experiment Management: Create and manage SwanLab experiments with custom project names and descriptions

Implementation Details:

  • Created src/lightning/pytorch/loggers/swanlab.py with full SwanLabLogger implementation
  • Updated src/lightning/pytorch/loggers/__init__.py to export SwanLabLogger
  • Follows existing Lightning logger patterns and conventions
  • Compatible with swanlab>=0.3.0

Dependencies:

  • Requires swanlab>=0.3.0 package (optional dependency)

Usage Example:

from lightning.pytorch.loggers import SwanLabLogger
from lightning.pytorch import Trainer

# Create logger
swanlab_logger = SwanLabLogger(
    project="my_project",
    experiment_name="experiment_1",
    description="My experiment description"
)

# Use with Trainer
trainer = Trainer(logger=swanlab_logger)

Before submitting

  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--21506.org.readthedocs.build/en/21506/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pl Generic label for PyTorch Lightning package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant