lightning/pytorch_lightning/metrics/regression/r2score.py

# 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 Any, Callable, Optional

from torchmetrics import R2Score as _R2Score

from pytorch_lightning.utilities.deprecation import deprecated


class R2Score(_R2Score):

    @deprecated(target=_R2Score, ver_deprecate="1.3.0", ver_remove="1.5.0")
    def __init__(
        self,
        num_outputs: int = 1,
        adjusted: int = 0,
        multioutput: str = "uniform_average",
        compute_on_step: bool = True,
        dist_sync_on_step: bool = False,
        process_group: Optional[Any] = None,
        dist_sync_fn: Callable = None,
    ):
        """
        This implementation refers to :class:`~torchmetrics.R2Score`.

        .. deprecated::
            Use :class:`~torchmetrics.R2Score`. Will be removed in v1.5.0.
        """