lightning/pytorch_lightning/metrics/functional/r2score.py

32 lines
1023 B
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 torchmetrics.functional import r2score as _r2score
from pytorch_lightning.metrics.utils import deprecated_metrics
@deprecated_metrics(target=_r2score)
def r2score(
preds: torch.Tensor,
target: torch.Tensor,
adjusted: int = 0,
multioutput: str = "uniform_average",
) -> torch.Tensor:
"""
.. deprecated::
Use :func:`torchmetrics.functional.r2score`. Will be removed in v1.5.0.
"""