54 lines
1.7 KiB
Python
54 lines
1.7 KiB
Python
# Copyright The PyTorch Lightning team.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Warning-related utilities."""
|
|
import warnings
|
|
from functools import partial
|
|
|
|
from pytorch_lightning.utilities.distributed import rank_zero_only
|
|
|
|
|
|
def _warn(*args, stacklevel: int = 2, **kwargs):
|
|
warnings.warn(*args, stacklevel=stacklevel, **kwargs)
|
|
|
|
|
|
@rank_zero_only
|
|
def rank_zero_warn(*args, stacklevel: int = 4, **kwargs):
|
|
_warn(*args, stacklevel=stacklevel, **kwargs)
|
|
|
|
|
|
class PossibleUserWarning(UserWarning):
|
|
"""Warnings that could be false positives."""
|
|
|
|
|
|
class LightningDeprecationWarning(DeprecationWarning):
|
|
"""Deprecation warnings raised by PyTorch Lightning."""
|
|
|
|
|
|
# enable our warnings
|
|
warnings.simplefilter("default", LightningDeprecationWarning)
|
|
|
|
rank_zero_deprecation = partial(rank_zero_warn, category=LightningDeprecationWarning)
|
|
|
|
|
|
class WarningCache(set):
|
|
def warn(self, m, *args, stacklevel: int = 5, **kwargs):
|
|
if m not in self:
|
|
self.add(m)
|
|
rank_zero_warn(m, *args, stacklevel=stacklevel, **kwargs)
|
|
|
|
def deprecation(self, m, *args, stacklevel: int = 5, **kwargs):
|
|
if m not in self:
|
|
self.add(m)
|
|
rank_zero_deprecation(m, *args, stacklevel=stacklevel, **kwargs)
|