lightning/pytorch_lightning/metrics/classification/hamming_distance.py

38 lines
1.3 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 Any, Callable, Optional
from torchmetrics import HammingDistance as _HammingDistance
from pytorch_lightning.metrics.utils import deprecated_metrics
class HammingDistance(_HammingDistance):
@deprecated_metrics(target=_HammingDistance)
def __init__(
self,
threshold: float = 0.5,
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.HammingDistance`.
.. deprecated::
Use :class:`~torchmetrics.HammingDistance`. Will be removed in v1.5.0.
"""