Sanitize hparams that can't be json-serialized in `WandbLogger.log_hyperparameters()` #19769

awaelchli · 2024-04-12T15:18:32Z

What does this PR do?

Fixes a serialization error encountered in LitGPT when calling WandbLogger.log_hyperparameters().
Lightning-AI/litgpt#1281

Repro:

from pathlib import Path
from lightning.pytorch.loggers import WandbLogger

logger = WandbLogger()
logger.log_hyperparameters({"path": Path("/path")})

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

cc @Borda @awaelchli @morganmcg1 @borisdayma @scottire @parambharat @carmocca @justusschock

for more information, see https://pre-commit.ci

github-actions · 2024-04-12T17:40:28Z

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-11, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 2.1)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 2.2)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.2)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 2.1)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 2.2)	success	✅
pl-cpu (macOS-11, pytorch, 3.8, 1.13)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.13)	success	✅
pl-cpu (windows-2022, pytorch, 3.8, 1.13)	success	✅
pl-cpu (macOS-12, pytorch, 3.11, 2.0)	success	✅
pl-cpu (macOS-12, pytorch, 3.11, 2.1)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.0)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.1)	success	✅
pl-cpu (windows-2022, pytorch, 3.11, 2.0)	success	✅
pl-cpu (windows-2022, pytorch, 3.11, 2.1)	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, src/lightning/pytorch/loggers/wandb.py, tests/tests_pytorch/loggers/test_wandb.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs) (testing Lightning \| latest)	success	✅
pytorch-lightning (GPUs) (testing PyTorch \| latest)	success	✅

These checks are required after the changes to src/lightning/pytorch/loggers/wandb.py, tests/tests_pytorch/loggers/test_wandb.py, src/lightning/fabric/utilities/logger.py.

🟢 pytorch_lightning: Benchmarks

Check ID	Status
lightning.Benchmarks	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, src/lightning/pytorch/loggers/wandb.py.

🟢 fabric: Docs

Check ID	Status
docs-make (fabric, doctest)	success	✅
docs-make (fabric, html)	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py.

🟢 pytorch_lightning: Docs

Check ID	Status
docs-make (pytorch, doctest)	success	✅
docs-make (pytorch, html)	success	✅

These checks are required after the changes to src/lightning/pytorch/loggers/wandb.py.

🟢 lightning_fabric: CPU workflow

Check ID	Status
fabric-cpu (macOS-11, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
fabric-cpu (macOS-11, lightning, 3.11, 2.1)	success	✅
fabric-cpu (macOS-11, lightning, 3.11, 2.2)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.1)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.2)	success	✅
fabric-cpu (windows-2022, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
fabric-cpu (windows-2022, lightning, 3.11, 2.1)	success	✅
fabric-cpu (windows-2022, lightning, 3.11, 2.2)	success	✅
fabric-cpu (macOS-11, fabric, 3.8, 1.13)	success	✅
fabric-cpu (ubuntu-20.04, fabric, 3.8, 1.13)	success	✅
fabric-cpu (windows-2022, fabric, 3.8, 1.13)	success	✅
fabric-cpu (macOS-12, fabric, 3.11, 2.0)	success	✅
fabric-cpu (macOS-12, fabric, 3.11, 2.1)	success	✅
fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.0)	success	✅
fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.1)	success	✅
fabric-cpu (windows-2022, fabric, 3.11, 2.0)	success	✅
fabric-cpu (windows-2022, fabric, 3.11, 2.1)	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, tests/tests_fabric/utilities/test_logger.py.

🟢 lightning_fabric: Azure GPU

Check ID	Status
lightning-fabric (GPUs) (testing Fabric \| latest)	success	✅
lightning-fabric (GPUs) (testing Lightning \| latest)	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, tests/tests_fabric/utilities/test_logger.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, src/lightning/pytorch/loggers/wandb.py.

🟢 install

Check ID	Status
install-pkg (ubuntu-22.04, app, 3.8)	success	✅
install-pkg (ubuntu-22.04, app, 3.11)	success	✅
install-pkg (ubuntu-22.04, fabric, 3.8)	success	✅
install-pkg (ubuntu-22.04, fabric, 3.11)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.8)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.11)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.8)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.11)	success	✅
install-pkg (ubuntu-22.04, notset, 3.8)	success	✅
install-pkg (ubuntu-22.04, notset, 3.11)	success	✅
install-pkg (macOS-12, app, 3.8)	success	✅
install-pkg (macOS-12, app, 3.11)	success	✅
install-pkg (macOS-12, fabric, 3.8)	success	✅
install-pkg (macOS-12, fabric, 3.11)	success	✅
install-pkg (macOS-12, pytorch, 3.8)	success	✅
install-pkg (macOS-12, pytorch, 3.11)	success	✅
install-pkg (macOS-12, lightning, 3.8)	success	✅
install-pkg (macOS-12, lightning, 3.11)	success	✅
install-pkg (macOS-12, notset, 3.8)	success	✅
install-pkg (macOS-12, notset, 3.11)	success	✅
install-pkg (windows-2022, app, 3.8)	success	✅
install-pkg (windows-2022, app, 3.11)	success	✅
install-pkg (windows-2022, fabric, 3.8)	success	✅
install-pkg (windows-2022, fabric, 3.11)	success	✅
install-pkg (windows-2022, pytorch, 3.8)	success	✅
install-pkg (windows-2022, pytorch, 3.11)	success	✅
install-pkg (windows-2022, lightning, 3.8)	success	✅
install-pkg (windows-2022, lightning, 3.11)	success	✅
install-pkg (windows-2022, notset, 3.8)	success	✅
install-pkg (windows-2022, notset, 3.11)	success	✅

These checks are required after the changes to src/lightning/fabric/utilities/logger.py, src/lightning/pytorch/loggers/wandb.py.

Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

codecov · 2024-04-12T18:08:03Z

Codecov Report

Merging #19769 (b884606) into master (67b270b) will decrease coverage by 26%.
The diff coverage is 92%.

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #19769     +/-   ##
=========================================
- Coverage      84%      59%    -26%     
=========================================
  Files         424      419      -5     
  Lines       34918    34832     -86     
=========================================
- Hits        29360    20385   -8975     
- Misses       5558    14447   +8889

…perparameters()` (#19769)

serialize

8e4e23a

github-actions bot added fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package labels Apr 12, 2024

[pre-commit.ci] auto fixes from pre-commit.com hooks

f117ea2

for more information, see https://pre-commit.ci

awaelchli added the logger: wandb Weights & Biases label Apr 12, 2024

awaelchli added this to the 2.2.x milestone Apr 12, 2024

awaelchli and others added 5 commits April 12, 2024 17:31

test

7c78779

[pre-commit.ci] auto fixes from pre-commit.com hooks

74ee1c3

for more information, see https://pre-commit.ci

move

1c8990b

[pre-commit.ci] auto fixes from pre-commit.com hooks

65a1d84

for more information, see https://pre-commit.ci

chlog

8e8e15e

awaelchli marked this pull request as ready for review April 12, 2024 17:40

awaelchli requested review from carmocca, justusschock, Borda and williamFalcon as code owners April 12, 2024 17:40

fix

7b21a33

carmocca approved these changes Apr 12, 2024

View reviewed changes

Borda approved these changes Apr 12, 2024

View reviewed changes

mergify bot added the ready PRs ready to be merged label Apr 12, 2024

windows

b884606

awaelchli merged commit ce90b38 into master Apr 14, 2024
112 checks passed

awaelchli deleted the bugfix/wandb-json-serializable branch April 14, 2024 13:01

awaelchli added a commit that referenced this pull request Apr 22, 2024

Sanitize hparams that can't be json-serialized in `WandbLogger.log_hy…

9fa8e3a

…perparameters()` (#19769)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sanitize hparams that can't be json-serialized in `WandbLogger.log_hyperparameters()` #19769

Sanitize hparams that can't be json-serialized in `WandbLogger.log_hyperparameters()` #19769

awaelchli commented Apr 12, 2024 •

edited by github-actions bot

github-actions bot commented Apr 12, 2024 •

edited

codecov bot commented Apr 12, 2024 •

edited

Sanitize hparams that can't be json-serialized in WandbLogger.log_hyperparameters() #19769

Sanitize hparams that can't be json-serialized in WandbLogger.log_hyperparameters() #19769

Conversation

awaelchli commented Apr 12, 2024 • edited by github-actions bot

What does this PR do?

github-actions bot commented Apr 12, 2024 • edited

⚡ Required checks status: All passing 🟢

Groups summary

codecov bot commented Apr 12, 2024 • edited

Codecov Report

Sanitize hparams that can't be json-serialized in `WandbLogger.log_hyperparameters()` #19769

Sanitize hparams that can't be json-serialized in `WandbLogger.log_hyperparameters()` #19769

awaelchli commented Apr 12, 2024 •

edited by github-actions bot

github-actions bot commented Apr 12, 2024 •

edited

codecov bot commented Apr 12, 2024 •

edited