lightning/pytorch_lightning/metrics/functional/hamming_distance.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.
import torch
from torchmetrics.functional import hamming_distance as _hamming_distance

from pytorch_lightning.metrics.utils import deprecated_metrics, void


@deprecated_metrics(target=_hamming_distance)
def hamming_distance(preds: torch.Tensor, target: torch.Tensor, threshold: float = 0.5) -> torch.Tensor:
    """
    .. deprecated::
        Use :func:`torchmetrics.functional.hamming_distance`. Will be removed in v1.5.0.
    """
    return void(preds, target, threshold)