Use `FutureWarning` instead of `DeprecationWarning` for deprecation warning
#11,525 opened on Jan 18, 2022
Repository metrics
- Stars
- (26,687 stars)
- PR merge metrics
- (Avg merge 9d 15h) (3 merged PRs in 30d)
Description
basically a copy of https://github.com/PyTorchLightning/metrics/issues/744 which was addressed in https://github.com/PyTorchLightning/metrics/pull/749
🚀 Feature
see suggestion in https://github.com/PyTorchLightning/metrics/pull/740#discussion_r782088021
Motivation
most of the deprecations in TM are meant to users not developers
Pitch
Replace DeprecationWarning with FutureWarning defined at:
https://github.com/PyTorchLightning/pytorch-lightning/blob/033dba1494a177954e8ca59bc74b1635e83b9efa/pytorch_lightning/utilities/warnings.py#L44
and remove:
https://github.com/PyTorchLightning/pytorch-lightning/blob/033dba1494a177954e8ca59bc74b1635e83b9efa/pytorch_lightning/utilities/warnings.py#L48-L49
Alternatives
Keep using DeprecationWarning.
Additional context
-
exception
DeprecationWarningBase class for warnings about deprecated features when those warnings are intended for other Python developers. Ignored by the default warning filters, except in the__main__module (PEP 565). Enabling the Python Development Mode shows this warning. -
exception
FutureWarningBase class for warnings about deprecated features when those warnings are intended for end users of applications that are written in Python.
If you enjoy Lightning, check out our other projects! ⚡
-
Metrics: Machine learning metrics for distributed, scalable PyTorch applications.
-
Lite: 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: 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: Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.
-
Lightning Transformers: Flexible interface for high-performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.
cc @borda