lightning/pytorch_lightning/metrics/functional/average_precision.py

34 lines
1.2 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.
from typing import List, Optional, Sequence, Union
import torch
from torchmetrics.functional import average_precision as _average_precision
from pytorch_lightning.utilities.deprecation import deprecated
@deprecated(target=_average_precision, ver_deprecate="1.3.0", ver_remove="1.5.0")
def average_precision(
preds: torch.Tensor,
target: torch.Tensor,
num_classes: Optional[int] = None,
pos_label: Optional[int] = None,
sample_weights: Optional[Sequence] = None,
) -> Union[List[torch.Tensor], torch.Tensor]:
"""
.. deprecated::
Use :func:`torchmetrics.functional.average_precision`. Will be removed in v1.5.0.
"""