Lightning-AI / Lightning-AI/pytorch-lightning

Add log_image for Tensorboard logger

Open
#15,733 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion logger won't fix
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

## 🚀 Feature

Currently Wandb and Neptune loggers have `.log_image()` method. It would be great to have the same method for Tensorboard also, so that we don't need to modify the code when changing the logger.

### Motivation

For quick experimentations, usually I start with Tensorboard logger first. Once the code is more stable and I want to do long-training, I switch to Wandb so that I can monitor the training progress remotely. Having the same method simplifies the user code.

### Pitch

Currently Tensorboard logger can log images by directly call the `.experiment.add_image()` method. The new `.log_image()` method would simply call this method.

### Alternatives

To handle different ways of logging images depending on the logger, user code either needs to (1) detect which logger is being used, and call the corresponding method to log images, or (2) override Tensorboard logger with the proposed change. Both options are not ideal.

### Additional context

______________________________________________________________________

#### If you enjoy Lightning, check out our other projects! ⚡

- [**Metrics**](https://github.com/Lightning-AI/metrics): Machine learning metrics for distributed, scalable PyTorch applications.

- [**Lite**](https://pytorch-lightning.readthedocs.io/en/latest/starter/lightning_lite.html): enables pure PyTorch users to scale their existing code on any kind of device while retaining full control over their own loops and optimization logic.

- [**Flash**](https://github.com/Lightning-AI/lightning-flash): The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, fine-tuning, and solving problems with deep learning.

- [**Bolts**](https://github.com/Lightning-AI/lightning-bolts): Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.

- [**Lightning Transformers**](https://github.com/Lightning-AI/lightning-transformers): Flexible interface for high-performance research using SOTA Transformers leveraging PyTorch Lightning, Transformers, and Hydra.

cc @borda @awaelchli @Blaizzy

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Tensorboard logger entry point and compare the existing `.log_image()` methods in the Wandb and Neptune loggers. Trace how Tensorboard currently calls `.experiment.add_image()`, then make the new method provide equivalent logger usage and verify that image logging works through the common interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
machine-learning
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.