Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the error message for installing tensorboardx #17053

Merged
merged 2 commits into from
Mar 14, 2023
Merged

Improve the error message for installing tensorboardx #17053

merged 2 commits into from
Mar 14, 2023

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Mar 13, 2023 •
edited by github-actions bot
Loading

What does this PR do?

Fixes #16810

Adds information to the error message that helps the user determine why tensorboard or tensorboardx can't be imported.

cc @Borda @awaelchli @carmocca @justusschock

@awaelchli awaelchli added bug Something isn't working logger: tensorboard labels Mar 13, 2023
@awaelchli awaelchli added this to the v1.9.x milestone Mar 13, 2023
@github-actions github-actions bot added the fabric lightning.fabric.Fabric label Mar 13, 2023
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Mar 13, 2023
@awaelchli awaelchli marked this pull request as ready for review March 13, 2023 03:02
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2023 •
edited
Loading

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow
Check ID Status
pl-cpu (macOS-11, lightning, 3.8, 1.11) success ✅
pl-cpu (macOS-11, lightning, 3.9, 1.12) success ✅
pl-cpu (macOS-11, lightning, 3.10, 1.13) success ✅
pl-cpu (macOS-11, lightning, 3.8, 1.11, oldest) success ✅
pl-cpu (macOS-11, lightning, 3.9, 2.0, pre) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 1.11) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.12) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest) success ✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 2.0, pre) success ✅
pl-cpu (windows-2022, lightning, 3.9, 1.11) success ✅
pl-cpu (windows-2022, lightning, 3.10, 1.12) success ✅
pl-cpu (windows-2022, lightning, 3.10, 1.13) success ✅
pl-cpu (windows-2022, lightning, 3.8, 1.11, oldest) success ✅
pl-cpu (windows-2022, lightning, 3.9, 2.0, pre) 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 ✅

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

🟢 pytorch_lightning: Azure GPU
Check ID Status
pytorch-lightning (GPUs) success ✅

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

🟢 pytorch_lightning: Azure HPU
Check ID Status
pytorch-lightning (HPUs) success ✅

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

🟢 fabric: Docs
Check ID Status
make-doctest (fabric) success ✅
make-html (fabric) success ✅

These checks are required after the changes to src/lightning/fabric/loggers/tensorboard.py.

🟢 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) success ✅
make-html (pytorch) success ✅

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

🟢 lightning_fabric: CPU workflow
Check ID Status
fabric-cpu (macOS-11, lightning, 3.8, 1.11) success ✅
fabric-cpu (macOS-11, lightning, 3.9, 1.12) success ✅
fabric-cpu (macOS-11, lightning, 3.10, 1.13) success ✅
fabric-cpu (macOS-11, lightning, 3.8, 1.11, oldest) success ✅
fabric-cpu (macOS-11, lightning, 3.9, 2.0, pre) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.9, 1.11) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 1.12) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 1.13) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest) success ✅
fabric-cpu (ubuntu-20.04, lightning, 3.9, 2.0, pre) success ✅
fabric-cpu (windows-2022, lightning, 3.9, 1.11) success ✅
fabric-cpu (windows-2022, lightning, 3.10, 1.12) success ✅
fabric-cpu (windows-2022, lightning, 3.10, 1.13) success ✅
fabric-cpu (windows-2022, lightning, 3.8, 1.11, oldest) success ✅
fabric-cpu (windows-2022, lightning, 3.9, 2.0, pre) 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 ✅

These checks are required after the changes to src/lightning/fabric/loggers/tensorboard.py.

🟢 lightning_fabric: Azure GPU
Check ID Status
lightning-fabric (GPUs) success ✅

These checks are required after the changes to src/lightning/fabric/loggers/tensorboard.py.

🟢 mypy
Check ID Status
mypy success ✅

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

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

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

🟢 link-check
Check ID Status
markdown-link-check success ✅

These checks are required after the changes to src/lightning/fabric/CHANGELOG.md, src/lightning/pytorch/CHANGELOG.md.

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
Copy link

codecov bot commented Mar 13, 2023 •
edited
Loading

Codecov Report

Merging #17053 (4d1bfaf) into master (35d1562) will decrease coverage by 23%.
The diff coverage is 0%.

Additional details and impacted files 
@@            Coverage Diff            @@
##           master   #17053     +/-   ##
=========================================
- Coverage      82%      59%    -23%     
=========================================
  Files         436      413     -23     
  Lines       31739    31456    -283     
=========================================
- Hits        25985    18657   -7328     
- Misses       5754    12799   +7045

@awaelchli awaelchli added the fun Staff contributions outside working hours - to differentiate from the "community" label label Mar 13, 2023
@mergify mergify bot added the ready PRs ready to be merged label Mar 14, 2023
@awaelchli awaelchli merged commit a22242b into master Mar 14, 2023
@awaelchli awaelchli deleted the bugfix/tensorboard-error branch March 14, 2023 19:27
Borda pushed a commit that referenced this pull request Mar 31, 2023
@awaelchli @Borda
Improve the error message for installing tensorboardx (#17053)
f36e43a 
(cherry picked from commit a22242b)
lantiga pushed a commit that referenced this pull request Apr 3, 2023
@awaelchli @lantiga
Improve the error message for installing tensorboardx (#17053)
ff09e40 
(cherry picked from commit a22242b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justusschock justusschock justusschock approved these changes

@carmocca carmocca carmocca approved these changes

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

Assignees
No one assigned
Labels
bug Something isn't working fabric lightning.fabric.Fabric fun Staff contributions outside working hours - to differentiate from the "community" label logger: tensorboard pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Milestone
v1.9.x
Development

Successfully merging this pull request may close these issues.

ModuleNotFoundError: Neither tensorboard nor tensorboardX is available.
3 participants
@awaelchli @carmocca @justusschock