lightning/pytorch_lightning/metrics/functional/reduction.py

36 lines
1.5 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.
import torch
from pytorch_lightning.metrics.utils import reduce as __reduce, class_reduce as __cr
from pytorch_lightning.utilities import rank_zero_warn
def reduce(to_reduce: torch.Tensor, reduction: str) -> torch.Tensor:
rank_zero_warn(
"This `reduce` was deprecated in v1.1.0 in favor of"
" `pytorch_lightning.metrics.utils import reduce`."
" It will be removed in v1.3.0", DeprecationWarning
)
return __reduce(to_reduce=to_reduce, reduction=reduction)
def class_reduce(num: torch.Tensor, denom: torch.Tensor, weights: torch.Tensor, class_reduction: str = 'none'):
rank_zero_warn(
"This `class_reduce` was deprecated in v1.1.0 in favor of"
" `pytorch_lightning.metrics.utils import class_reduce`."
" It will be removed in v1.3.0", DeprecationWarning
)
return __cr(num=num, denom=denom, weights=weights, class_reduction=class_reduction)